aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/FORMATTING.md
Commit message (Collapse)AuthorAge
* more doxygen lexicon changes to eliminate errorsGravatar Kurtis Rader2016-04-24
| | | | | | I noticed that Doxygen was also complaining about the "<asis>" and "<bs>" tags. So convert those to the backslash form like we did for "<outp>" in the previous commit.
* replace <outp> command with \outp in docsGravatar Kurtis Rader2016-04-23
| | | | | | | | | | Doxygen has been warning that `<outp>` and `</outp>` are not valid XML/HTML commands since commit cb6d5d76 on 20016-04-04. That's primarily because there is at present no way to tell Doxygen to recognize new XML/HTML tags. The actual errors look like this: ``` .../string.doxygen:187: warning: Unsupported xml/html tag </outp> found ``` I hate build errors since they a) cause needless concern, and b) make it harder to notice when I've introduced a new error. So switch from XML/C## style markup to Doxygen style markup for the "outp" annotation.
* update lexicon for latest docsGravatar Mark Griffiths2016-04-04
| | | | | | | | | | | | | | | | | | | | | | | | | | | Closes #2699 Fixes issues with: * 'string' function synopsis * Redirection display issues * Better file & path detection * Rendering of % & @ chars in both html and man * @ symbol in tutorial Improves robustness by implementing an @EOL marker to prevent hold buffer dumping extra chars after the end of an expression. Added new '{{' and '}}' meta-chars for when you want curly braces in a regexp that was previously tripping up the lexicon. Improve man/html presentation consistency for * string * printf * prompt_pwd * type Use cli-styling for 'practical' examples. Add <bs> tag for presenting content with preceding backslash. Signed-off-by: Mark Griffiths <mark@thebespokepixel.com>
* remove "doc" make target and rename "user_doc"Gravatar Kurtis Rader2016-03-30
| | | | Fixes #2874
* Fixed a couple of typosGravatar Mark Griffiths2014-09-07
|
* Updated Testing Info. Ready for PR.Gravatar Mark Griffiths2014-09-04
| | | | | | | | | | | | Major documentation cleanup and update. - Fixes Issue #1557 - Moves entire documentation to Markdown format. Much simpler. - Fully supports Doxygen 1.8.7+ - All documentation targets updated: user_doc, share/man, doc and doc/refman.pdf. - Tested across Ubuntu, CentOS and Mac OS. See doc_src/FORMATTING.md for in depth rationale and style guide.
* Fixed Doxygen required version to 1.8.7Gravatar Mark Griffiths2014-09-04
| | | | | | | Doxygen 1.8.6 and lower do not have the \\htmlonly[block] directive which fixes a multitude of problems in the rendering of the docs. In Doxygen 1.8.7 the list of understood HTML entities was greatly increased. I tested earlier versions and many little issues returned.
* Added Doxygen notesGravatar Mark Griffiths2014-09-04
|
* Added notes to Formatting docGravatar Mark Griffiths2014-09-04
|
* Formatting additionsGravatar Mark Griffiths2014-09-04
|
* Formatting updatesGravatar Mark Griffiths2014-09-03
|
* Addition of 'ascii fish' logoGravatar Mark Griffiths2014-09-03
| | | | + small fixes
* Various additions and fixesGravatar Mark Griffiths2014-09-03
|
* Fish documentation formatting guidelinesGravatar Mark Griffiths2014-09-03