Commit graph

6 commits

Author SHA1 Message Date
Timo Tijhof
5001f914d5 docs: Set stable permalink on markdown files
In Doxygen 1.9.7, the URL generation logic changed such that input
files in directories (i.e. /docs/Hooks.md) are published with the
slug `md_docs_2Hooks.html` instead of `md_docs_Hooks.html`.

This was done to improve an edge case where if two conflicting
files existed (e.g. docs_Foo.md and docs/Foo.md) both can now get
their own stable URL in a determimistic way (e.g. as opposed to
a-z sorting and appending _2 only if a conflict exists). But this
made other more common URLs no longer stable. Work around this by
setting an explict permalink for each markdown file.

Ref https://github.com/doxygen/doxygen/issues/10721.

Change-Id: Ifeb03602452c1148bd372555bebac9922c583ac2
2024-03-09 22:04:05 +00:00
Siddharth VP
8242e84f9d Fix typos in docs
Change-Id: I5ccf296e0bd9afd8a82b620002346496cef18f0e
2022-01-09 21:59:57 +05:30
Tim Starling
a30b328bd4 Rename CoreMagicWords to CoreMagicVariables and update docs
There's already a thing called magic words, and this is not it. These
things are called variables. There are many usages of this term in the
source. The term was introduced by Lee in 2002: originally
OutputPage::replaceVariables() contained only this functionality.

I introduced the term "magic word", meaning a localizable keyword.
Localizable keywords are an abstraction not limited to this use case.

"Magic variables" is a neologism, but I suppose it is permissible, since
it disambiguates. Whereas calling a variable a magic word conflates rather
than disambiguates.

Fix terminology in magicword.md and update the examples.

Change-Id: I621c888e3790a145ca9978f6b30ff1a8f685b64c
2020-06-11 13:28:45 +10:00
DannyS712
8f92469c6c docs - minor cleanup, including fixing markdown syntax
Use code highlighting where relevant
Fix list syntax in memcached.md to render lists without paragraph breaks
Add a missing period to schema.md

Change-Id: I763cfd479968cedbf952c231283d33b82a0910d6
2020-05-23 07:58:14 +00: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
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