#684 Sample service documentation

modules/boonex/events/classes/BxEventsModule.php

@@ -10,7 +10,7 @@
  */
 
 /**
- * Groups profiles module.
+ * Events profiles module.
  */
 class BxEventsModule extends BxBaseModGroupsModule
 {
@@ -53,7 +53,7 @@ class BxEventsModule extends BxBaseModGroupsModule
     /**
      * @page service Service Calls
      * @section Events Events
-     * @subsection calendar
+     * @subsection bx_events-calendar calendar
      * @see BxEventsModule::serviceCalendar
      * 
      * Shows event or events calendar
@@ -61,7 +61,10 @@ class BxEventsModule extends BxBaseModGroupsModule
      * @param $aData additional data to point which events to show, leave empty to show all events, specify event's ID in 'event' array key to show calendar for one event only. If only one event is specified then it will show calendar only if it's repeating event.
      * @param $sTemplate template to use to show calendar, or leave empty for default template, possible options: calendar.html, calendar_compact.html
      * @return HTML string with calendar to display on the site, all necessary CSS and JS files are automatically added to the HEAD section of the site HTML. On error empty string is returned.
-     */ 
+     */
+    /** 
+     * @ref bx_events-calendar "calendar"
+     */
     public function serviceCalendar($aData = array(), $sTemplate = 'calendar.html')
     {
         if (isset($aData['event'])) {
@@ -82,14 +85,17 @@ class BxEventsModule extends BxBaseModGroupsModule
     /**
      * @page service Service Calls
      * @section Events Events
-     * @subsection process_reminders
+     * @subsection bx_events-process_reminders process_reminders
      * @see BxEventsModule::serviceProcessReminders
      * 
      * Send remiders to event's participants.
      *
      * It must be processed once every hour for the proper processing.
      * @return nothing
-     */ 
+     */
+    /** 
+     * @ref bx_events-process_reminders "process_reminders"
+     */
     public function serviceProcessReminders()
     {
         $iNow = time();
@@ -109,7 +115,7 @@ class BxEventsModule extends BxBaseModGroupsModule
     /**
      * @page service Service Calls
      * @section Events Events
-     * @subsection get_timeline_post
+     * @subsection bx_events-get_timeline_post get_timeline_post
      * @see BxEventsModule::serviceGetTimelinePost
      *
      * Get Timeline post. It's needed for Timeline module.
@@ -117,6 +123,9 @@ class BxEventsModule extends BxBaseModGroupsModule
      * @param $aEvent timeline event array from Timeline module
      * @return array in special format which is needed specifically for Timeline module to display the data.
      */
+    /** 
+     * @ref bx_events-get_timeline_post "get_timeline_post"
+     */
     public function serviceGetTimelinePost($aEvent, $aBrowseParams = array())
     {
         $a = parent::serviceGetTimelinePost($aEvent, $aBrowseParams);