#684 doc

inc/classes/BxDol.php

@@ -2,14 +2,109 @@
 /**
  * Copyright (c) UNA, Inc - https://una.io
  * MIT License - https://opensource.org/licenses/MIT
- *
- * @defgroup    UnaCore UNA Core
- * @{
  */
 
 /**
  * @page objects Objects
  * Classes which represents high level programming constructions to generate ready functionality, like Comments, Votings, Forms.
+ *
+ * @section captcha CAPTCHA
+ * @ref BxDolCaptcha
+ *
+ * @section category Category
+ * @ref BxDolCategory
+ *
+ * @section comments Comments
+ * @ref BxDolCmts
+ *
+ * @section connection Connection
+ * @ref BxDolConnection
+ *
+ * @section content_info Content Info
+ * @ref BxDolContentInfo
+ *
+ * @section cover Cover
+ * @ref BxDolCover
+ *
+ * @section editor Editor
+ * @ref BxDolEditor
+ *
+ * @section email_templates Email Templates
+ * @ref BxDolEmailTemplates
+ *
+ * @section favorites Favorites
+ * @ref BxDolFavorite
+ *
+ * @section feature Feature
+ * @ref BxDolFeature
+ *
+ * @section file_handler File View Handlers
+ * @ref BxDolFileHandler
+ *
+ * @section forms Forms
+ * @ref BxDolForm
+ * 
+ * @section grid Grid
+ * @ref BxDolGrid
+ *
+ * @section informer Informer
+ * @ref BxDolInformer
+ *
+ * @section key Keys
+ * @ref BxDolKey
+ * 
+ * @section live_updates Live Updates
+ * @ref BxDolLiveUpdates
+ * 
+ * @section menu Menu
+ * @ref BxDolMenu
+ *
+ * @section metatags Meta Tags
+ * @ref BxDolMetatags
+ * 
+ * @section page Page
+ * @ref BxDolPage
+ *
+ * @section permalinks Permalinks
+ * @ref BxDolPermalinks
+ * 
+ * @section privacy Privacy
+ * @ref BxDolPrivacy
+ *
+ * @section reports Reports
+ * @ref BxDolReport
+ * 
+ * @section rss RSS
+ * @ref BxDolRss
+ *
+ * @section search Search
+ * @ref BxDolSearch
+ *
+ * @section storage Storage
+ * @ref BxDolStorage
+ * 
+ * @section transcoder_images Transcoder: Images 
+ * @ref BxDolTranscoderImage
+ *
+ * @section transcoder_proxy Transcoder: Proxy
+ * @ref BxDolTranscoderProxy
+ *
+ * @section transcoder_videos Transcoder: Videos
+ * @ref BxDolTranscoderVideo
+ * 
+ * @section uploader Uploader
+ * @ref BxDolUploader
+ * 
+ * @section views Views
+ * @ref BxDolView
+ *
+ * @section votes Votes
+ * @ref BxDolVote
+ */
+
+/**
+ * @defgroup    UnaCore UNA Core
+ * @{
  */
 
 /**

inc/classes/BxDolCaptcha.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section captcha CAPTCHA
- * @ref BxDolCaptcha
- */
-
 /**
  * CAPTCHA objects.
  *

inc/classes/BxDolCategory.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section category Category
- * @ref BxDolCategory
- */
-
 /**
  * Category object, it can make regular form lists to act as categories by making it clickable and display search results with all contents with the same category.
  * Also it provides services to list all categories with number if items in each category.

inc/classes/BxDolCmts.php

@@ -39,12 +39,6 @@ define('BX_CMT_PFP_BOTTOM', 'bottom');
 define('BX_CMT_RATE_VALUE_PLUS', 1);
 define('BX_CMT_RATE_VALUE_MINUS', -1);
 
-/**
- * @page objects
- * @section comments Comments
- * @ref BxDolCmts
- */
-
 /**
  * Comments for any content
  *

inc/classes/BxDolConnection.php

@@ -52,12 +52,6 @@ define('BX_CONNECTIONS_CONTENT_TYPE_INITIATORS', 'initiators');
  */
 define('BX_CONNECTIONS_CONTENT_TYPE_COMMON', 'common');
 
-/**
- * @page objects
- * @section connection Connection
- * @ref BxDolConnection
- */
-
 /**
  * Connection is usefull when you need to organize some sorts of connections between different content,
  * for example: friends, contacts, favorites, block lists, subscriptions, etc.

inc/classes/BxDolContentInfo.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section content info ContentInfo
- * @ref BxDolContentInfo
- */
-
 /**
  * Get content info from Content modules
  *

inc/classes/BxDolContentInfoCmts.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section content info ContentInfo
- * @ref BxDolContentInfo
- */
-
 class BxDolContentInfoCmts extends BxDolContentInfo
 {
     protected $_oCmts;

inc/classes/BxDolCover.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section cover Cover
- * @ref BxDolCover
- */
-
 /**
  * Cover.
  *

inc/classes/BxDolEditor.php

@@ -25,12 +25,6 @@ define('BX_EDITOR_FULL', 2);
  */
 define('BX_EDITOR_MINI', 3);
 
-/**
- * @page objects
- * @section editor Editor
- * @ref BxDolEditor
- */
-
 /**
  * WYSIWYG editors.
  *

inc/classes/BxDolEmailTemplates.php

@@ -9,12 +9,6 @@
 
 bx_import('BxDolPermalinks');
 
-/**
- * @page objects
- * @section email_templates Email Templates
- * @ref BxDolEmailTemplates
- */
-
 /**
  * Email templates are used to send preformated messages.
  *

inc/classes/BxDolFavorite.php

@@ -11,12 +11,6 @@ define('BX_DOL_FAVORITE_USAGE_BLOCK', 'block');
 define('BX_DOL_FAVORITE_USAGE_INLINE', 'inline');
 define('BX_DOL_FAVORITE_USAGE_DEFAULT', BX_DOL_FAVORITE_USAGE_BLOCK);
 
-/**
- * @page objects
- * @section favorites Favorites
- * @ref BxDolFavorite
- */
-
 /**
  * Track any object favorites automatically
  *

inc/classes/BxDolFeature.php

@@ -11,12 +11,6 @@ define('BX_DOL_FEATURED_USAGE_BLOCK', 'block');
 define('BX_DOL_FEATURED_USAGE_INLINE', 'inline');
 define('BX_DOL_FEATURED_USAGE_DEFAULT', BX_DOL_FEATURED_USAGE_BLOCK);
 
-/**
- * @page objects
- * @section feature Feature
- * @ref BxDolFeature
- */
-
 /**
  * Track any object feature automatically
  *

inc/classes/BxDolFileHandler.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section file_handler File view handlers
- * @ref BxDolFileHandler
- */
-
 /**
  * File preview object, it's used to preview different files in browser which browse usually doesn't support.
  * 

inc/classes/BxDolForm.php

@@ -15,12 +15,6 @@ define('BX_DATA_LISTS_KEY_PREFIX', '#!');
 define('BX_DATA_VALUES_DEFAULT', 'LKey'); ///< Use default values for data items, @see BxDolForm::getDataItems
 define('BX_DATA_VALUES_ADDITIONAL', 'LKey2'); ///< Use additional values for data items, @see BxDolForm::getDataItems
 
-/**
- * @page objects
- * @section forms Forms
- * @ref BxDolForm
- */
-
 /**
  * Forms allows to display forms from data stored in DB tables, before it was possible to display forms from PHP arrays only.
  *

inc/classes/BxDolGrid.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section grid Grid
- * @ref BxDolGrid
- */
-
 /**
  * Grid for any content.
  *

inc/classes/BxDolInformer.php

@@ -11,12 +11,6 @@ define('BX_INFORMER_ALERT', 1);
 define('BX_INFORMER_INFO', 2);
 define('BX_INFORMER_ERROR', 3);
 
-/**
- * @page objects
- * @section informer Informer
- * @ref BxDolInformer
- */
-
 /**
  * Informer.
  *

inc/classes/BxDolKey.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section key Keys
- * @ref BxDolKey
- */
-
 /**
  * Key objects - automatically generate hashed keys.
  *

inc/classes/BxDolLiveUpdates.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section live_updates Live Updates
- * @ref BxDolLiveUpdates
- */
-
 class BxDolLiveUpdates extends BxDolFactory implements iBxDolSingleton
 {
 	protected $_oQuery;

inc/classes/BxDolMenu.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section menu Menu
- * @ref BxDolMenu
- */
-
 /**
  * Menus.
  *

inc/classes/BxDolMetatags.php

@@ -9,12 +9,6 @@
 
 define('BX_METATAGS_KEYWORDS_MAX', 9);
 
-/**
- * @page objects
- * @section metatags Meta-tags
- * @ref BxDolMetatags
- */
-
 // TODO: client side controls: some js to help to enter \@mentions and \#keywords(optional)
 // TODO: integrate to comments, try to integrate to one metatags object - maybe specify metatags object in comments object and make appropriate changes in comments, 
 //       comments content should be treated as main conetent and main content should be shown in search results

inc/classes/BxDolPage.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section page Page
- * @ref BxDolPage
- */
-
 /**
  * Pages.
  *

inc/classes/BxDolPermalinks.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section permalinks Permalinks
- * @ref BxDolPermalinks
- */
-
 /**
  * Permalinks for any content.
  *

inc/classes/BxDolPrivacy.php

@@ -15,12 +15,6 @@ define('BX_DOL_PG_FRIENDS', '5');
 
 define('BX_DOL_PG_DEFAULT', BX_DOL_PG_ALL);
 
-/**
- * @page objects
- * @section privacy Privacy
- * @ref BxDolPrivacy
- */
-
 /**
  * Privacy settings for any content.
  *

inc/classes/BxDolReport.php

@@ -13,12 +13,6 @@ define('BX_DOL_REPORT_USAGE_BLOCK', 'block');
 define('BX_DOL_REPORT_USAGE_INLINE', 'inline');
 define('BX_DOL_REPORT_USAGE_DEFAULT', BX_DOL_REPORT_USAGE_BLOCK);
 
-/**
- * @page objects
- * @section reports Reports
- * @ref BxDolReport
- */
-
 /**
  * Report any content
  *

inc/classes/BxDolRss.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section rss Rss
- * @ref BxDolRss
- */
-
 /**
  * This class unifies the usage of RSS feeds in the script.
  *

inc/classes/BxDolSearch.php

@@ -10,12 +10,6 @@
 define('BX_DOL_SEARCH_RESULTS_PER_PAGE_DEFAULT', 10);
 define('BX_DOL_SEARCH_KEYWORD_PAGE', 'site-search-page');
 
-/**
- * @page objects
- * @section search Search
- * @ref BxDolSearch
- */
-
 /**
  * Search class for different content.
  *

inc/classes/BxDolStorage.php

@@ -58,12 +58,6 @@ define('BX_DOL_STORAGE_DEFAULT_ICON_FONT', 'file-o'); ///< default font icon if
 
 define('BX_DOL_STORAGE_QUEUED_DELETIONS_PER_RUN', 200); ///< max number of file deletions per one cron run, @see BxDolStorage::pruneDeletions
 
-/**
- * @page objects
- * @section storage Storage
- * @ref BxDolStorage
- */
-
 /**
  * This class unify storage.
  * As the result there are many advantages:

inc/classes/BxDolTranscoderImage.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section transcoder_images Images Transcoder
- * @ref BxDolTranscoderImage
- */
-
 /**
  * This class transcodes images on the fly.
  * Transcoded image is saved in the specified storage engine and next time ready image is served.

inc/classes/BxDolTranscoderProxy.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section transcoder_proxy Proxy Transcoder 
- * @ref BxDolTranscoderProxy
- */
-
 /**
  * This transcoder can be used as universal transcoder for videos and images.
  * Depending on original file MIME type it calls the appropriate transcoder.

inc/classes/BxDolTranscoderVideo.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section transcoder_videos Videos Transcoder
- * @ref BxDolTranscoderVideo
- */
-
 /**
  * This class transcodes videos and generates video thumbnails.
  *

inc/classes/BxDolUploader.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-/**
- * @page objects
- * @section uploader Uploader
- * @ref BxDolUploader
- */
-
 /**
  * Uploaders are disigned to work as form field in forms. @see BxDolForm.
  *

inc/classes/BxDolView.php

@@ -13,12 +13,6 @@ define('BX_DOL_VIEW_USAGE_BLOCK', 'block');
 define('BX_DOL_VIEW_USAGE_INLINE', 'inline');
 define('BX_DOL_VIEW_USAGE_DEFAULT', BX_DOL_VIEW_USAGE_BLOCK);
 
-/**
- * @page objects
- * @section views Views
- * @ref BxDolView
- */
-
 /**
  * Track any object views automatically
  *

inc/classes/BxDolVote.php

@@ -16,12 +16,6 @@ define('BX_DOL_VOTE_USAGE_BLOCK', 'block');
 define('BX_DOL_VOTE_USAGE_INLINE', 'inline');
 define('BX_DOL_VOTE_USAGE_DEFAULT', BX_DOL_VOTE_USAGE_BLOCK);
 
-/**
- * @page objects
- * @section votes Votes
- * @ref BxDolVote
- */
-
 /**
  * Vote for any content
  *

modules/boonex/oauth2/classes/BxOAuthAPI.php

@@ -30,7 +30,7 @@ class BxOAuthAPI extends BxDol
     }
 
     /**
-     * @page API API
+     * @page API
      * @section api_me /m/oauth2/api/me
      * 
      * Provides information about current profile.  
@@ -78,7 +78,7 @@ class BxOAuthAPI extends BxDol
     }
 
     /**
-     * @page API API
+     * @page API
      * @section api_user /m/oauth2/api/user
      * 
      * Provides information about particular profile profile.