From f9b308ffe0d4ff067b759047432a0e67cb37ff2e Mon Sep 17 00:00:00 2001 From: Daniel Kraus Date: Mon, 6 Jun 2016 23:44:07 +0200 Subject: [PATCH] Write documentation. --- Doxyfile | 2 +- README.md | 4 ++-- README_DOC.md | 4 +--- gh-pages | 2 +- 4 files changed, 5 insertions(+), 7 deletions(-) diff --git a/Doxyfile b/Doxyfile index a49c620..2b4da09 100644 --- a/Doxyfile +++ b/Doxyfile @@ -778,7 +778,7 @@ RECURSIVE = NO # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = README.md +EXCLUDE = README.md Maintenance.php # 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 diff --git a/README.md b/README.md index bd574ea..f96e7f7 100644 --- a/README.md +++ b/README.md @@ -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 -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 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). diff --git a/README_DOC.md b/README_DOC.md index 3962c80..990d74f 100644 --- a/README_DOC.md +++ b/README_DOC.md @@ -15,13 +15,11 @@ LinkTitles\\Extension::parseContent() function. The extension provides two methods for batch-processing of pages. One is a @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 have access to your server and are authorized to run php from the command line. -@ref config variables are defined in LinkTitles.php. - @note The source code that is referenced in this documentation may not necessarily reflect the latest code in the repository! Make sure to check out the Git repository for the latest code. diff --git a/gh-pages b/gh-pages index 933023d..ad8db41 160000 --- a/gh-pages +++ b/gh-pages @@ -1 +1 @@ -Subproject commit 933023db7d05cffed2300fcbd00f0b7355579981 +Subproject commit ad8db4151dadcf1cf3458357d483732a9be3ccb9