Commit graph

6 commits

Author SHA1 Message Date
Holger Knust
0e70b9f974 docs: Restore welcome message on docs landing page
Restored mark up in Introduction.md to have Doxygen create the welcome page in docs.

Bug: T248706
Change-Id: Idfd2b13367428d6747bd79eac0f8e0e3980b13cd
2020-04-20 09:22:00 -04:00
DannyS712
2e3bdb3498 Miscellaneous documentation updates
Update references from .txt to .md when files have moved, a few other
tweaks, no changes to code.

Change-Id: I0bfd38c47b9fb0fc11ae98a0a674af66fb4c5a84
2020-02-16 04:38:38 +00:00
apaskulin
5223984589 docs: Fix link on intro page
Fixes broken link on intro page and re-adds sentence about
purpose of mediawiki.org.

Bug: T233244
Change-Id: Id164efc81d16083cf51ea180136a050723880e32
2019-12-09 08:44:01 -08:00
Arturek1
c11b745435 Implementation of Doxygen-friendly format
Markdown format implemented in docs/magicword.md and docs/memcached.md
A section with helpful resources has been added in docs/Introduction.md

Whitespaces removed, Intoduction.md modified

Unnecessary whitespaces have been removed. Helpful resources section has been modified.

Headings fixed, Title changed in magicword.md

Title changed from "magicword.txt" to "Magic Words" in docs/magicword.md. 
Some H1 headers changed to H2 in docs/memcached.md and docs/Introduction.md. 
An unnecessary sentence removed in docs/Introduction.md.

Change-Id: I5c9e8663c922be4ca5f0eea9d5c2469b1b18281c
Task: T111298
2019-12-04 21:08:15 +00:00
apaskulin
5443e647bf docs: Fix typo on Doxygen main page
This PR fixes a typo and removes a few extra words
from the Doxygen landing page.

Change-Id: Ieb09c0e72129f4c6b0ccd574daf2f9316f580259
2019-09-27 07:45:59 -07:00
Timo Tijhof
b7c5acd419 docs: Convert doxygen_first_page.php to proper Markdown
Doxygen has native support for indexing of Markdown pages.
It basically parses them the same way it parses the uglier
methodology of creating a PHP file containing a the markdown
text in a large comment that would start with `@page` or `@mainpage`.

* http://doxygen.nl/manual/commands.html#cmdpage
* http://doxygen.nl/manual/commands.html#cmdmainpage
* http://doxygen.nl/manual/markdown.html#md_page_header

The internal reference name and page title (comparable to the string
passed to `@mainpage` or `@page`) are by default derived from the
file name (without suffix).

The internal reference name (for use in cross-page links) can also
be overidden with an `{#something}` annotation in the first heading.

When using the annotation `{#mainpage}` it changes the page type
from a regular `@page` to the `@mainpage`.

Change-Id: I0c25a49088825744773c4d87dde5688894b2004e
2019-09-04 22:57:02 +00:00