Write documentation.

This commit is contained in:
Daniel Kraus
2016-06-06 23:44:07 +02:00
parent bb86941682
commit f9b308ffe0
4 changed files with 5 additions and 7 deletions

View File

@ -778,7 +778,7 @@ RECURSIVE = NO
# Note that relative paths are relative to the directory from which doxygen is # Note that relative paths are relative to the directory from which doxygen is
# run. # run.
EXCLUDE = README.md EXCLUDE = README.md Maintenance.php
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded # directories that are symbolic links (a Unix file system feature) are excluded

View File

@ -5,9 +5,9 @@ MediaWiki extension that automatically adds links to words that match titles of
For more information, see http://www.mediawiki.org/wiki/Extension:LinkTitles For more information, see http://www.mediawiki.org/wiki/Extension:LinkTitles
Minimum requirements: MediaWiki 1.21+, PHP 5.3 Minimum requirements: MediaWiki 1.25, PHP 5.3
Source code documentation can be found at the [Github project Source code documentation can be found at the [Github project
pages](http://bovender.github.io/LinkTitles). pages](http://bovender.github.io/LinkTitles).
[![Flattr this](https://button.flattr.com/flattr-badge-large.png "Flattr this")](https://flattr.com/submit/auto?user_id=bovender&url=https%3A%2F%2Fgithub.com%2Fbovender%2FLinkTitles) This extension is [semantically versioned](http://semver.org).

View File

@ -15,13 +15,11 @@ LinkTitles\\Extension::parseContent() function.
The extension provides two methods for batch-processing of pages. One is a The extension provides two methods for batch-processing of pages. One is a
@link LinkTitles\\Special special page @endlink that provides web-access (by @link LinkTitles\\Special special page @endlink that provides web-access (by
default restricted to sysops). The other is a @link LinkTitlesCli default restricted to sysops). The other is a @link LinkTitles\\Cli
maintenance script @endlink that can be called from the command line if you maintenance script @endlink that can be called from the command line if you
have access to your server and are authorized to run php from the command have access to your server and are authorized to run php from the command
line. line.
@ref config variables are defined in LinkTitles.php.
@note The source code that is referenced in this documentation may not @note The source code that is referenced in this documentation may not
necessarily reflect the latest code in the repository! Make sure to check necessarily reflect the latest code in the repository! Make sure to check
out the Git repository for the latest code. out the Git repository for the latest code.