diff options
Diffstat (limited to 'www/wiki/extensions/SemanticMediaWiki/docs/technical/doxygen.php')
-rw-r--r-- | www/wiki/extensions/SemanticMediaWiki/docs/technical/doxygen.php | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/docs/technical/doxygen.php b/www/wiki/extensions/SemanticMediaWiki/docs/technical/doxygen.php new file mode 100644 index 00000000..8f9192b9 --- /dev/null +++ b/www/wiki/extensions/SemanticMediaWiki/docs/technical/doxygen.php @@ -0,0 +1,196 @@ +<?php + +die("Not a valid entry point\n"); + +/** + * This file does not hold any code. It is used mainly during the doxygen + * auto-documentation process + * + * @file + */ + +/** + * @mainpage Introduction + * + * Welcome to the auto-generated Semantic MediaWiki code documentation + * + * For information about how to install or configure Semantic MediaWiki, + * please visit the main site: + * + * https://www.semantic-mediawiki.org/ + */ + +/** + * This file does not hold any code. It is used mainly during the doxygen + * auto-documentation process + * + * @file + */ + +/** + * This group contains members that are related to the Semantic MediaWiki Api + * + * @defgroup Api Api + * @ingroup SMW + */ + +/** + * This group contains members that are related to the Store interface + * + * @defgroup Store Store + * @ingroup SMW + */ + +/** + * This group contains members that are related to the SQLStore implementation + * + * @defgroup SQLStore SQLStore + * @ingroup Store + */ + +/** + * This group contains members that are related to the Collector interface + * + * @defgroup Collector Collector + * @ingroup Store + */ + +/** + * This group contains members that are related to message, error, and parameter + * formatting + * + * @defgroup Formatter Formatter + * @ingroup SMW + */ + +/** + * This group contains members that are related to hooks, hook events, and + * hook registrations + * + * @see https://www.mediawiki.org/wiki/Manual:Hooks + * @see https://semantic-mediawiki.org/wiki/Hooks‎ + * + * @defgroup FunctionHook FunctionHook + * @ingroup SMW + */ + +/** + * This group contains members that are related to parser hooks and functions + * + * @defgroup ParserFunction ParserFunction + * @ingroup SMW + */ + +/** + * This group contains members that are related to special pages + * + * @see https://www.mediawiki.org/wiki/Manual:Special_pages + * + * @defgroup SpecialPage SpecialPage + * @ingroup SMW + */ + +/** + * This group contains members that are related to jobs + * + * @defgroup Job Job + * @ingroup SMW + */ + +/** + * This group contains members that are related to maintenance scripts + * + * @defgroup Maintenance Maintenance + * @ingroup SMW + */ + +/** + * This group contains members that are related to utility classes and support + * functions + * + * @defgroup Utility Utility + * @ingroup SMW + */ + +/** + * This group contains members that are related to supporting the Observer + * + * @defgroup Observer Observer + * @ingroup Utility + */ + +/** + * This group contains members that are related to supporting the Dependency + * Injection Framework + * + * @defgroup DependencyInjection Dependency Injection + * @ingroup Utility + */ + +/** + * This group contains members that are related to building of Dependency + * Injection objects + * + * @defgroup DependencyBuilder Dependency Builder + * @ingroup DependencyInjection + */ + +/** + * This group contains members that are related for requesting a Dependency + * Injection + * + * @defgroup DependencyRequestor Dependency Requestor + * @ingroup DependencyInjection + */ + +/** + * This group contains members that are related for speficcation of Dependency + * Objects + * + * @defgroup DependencyContainer Dependency Container + * @ingroup DependencyInjection + */ + +/** + * This group contains members that are related to handler classes (including + * object handler, hooks handler, instance handler etc.) + * + * @defgroup Handler Handler + * @ingroup Utility + */ + +/** + * This group contains members that are related to unit tests + * + * @defgroup Test Test + * @ingroup SMW + */ + +/** + * This group contains members that are related to the QueryPrinter unit tests + * + * @defgroup QueryPrinterTest QueryPrinterTest + * @ingroup Test + */ + +/** + * This group contains members that are related to the maintenance script unit + * tests + * + * @defgroup MaintenanceTest MaintenanceTest + * @ingroup Test + */ + +/** + * This group contains members that are related to the Store unit tests + * + * @defgroup StoreTest StoreTest + * @ingroup Test + */ + +/** + * This group contains members that are related to the SQLStore unit tests + * + * @defgroup SQLStoreTest SQLStoreTest + * @ingroup StoreTest + */ |