summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2018-04-22 09:20:15 (GMT)
committerGitHub <noreply@github.com>2018-04-22 09:20:15 (GMT)
commit196c6ffa3310237b79a28e8f7ed94f2d61142d39 (patch)
treeb08ecded50f461503c23b4f3d1a21988438fec8c
parent55f33990d4675db6378fc6f036274539557958a5 (diff)
parent17c8c0ee8c0dd06938f3b85db6361de24c1bbe58 (diff)
downloadDoxygen-196c6ffa3310237b79a28e8f7ed94f2d61142d39.zip
Doxygen-196c6ffa3310237b79a28e8f7ed94f2d61142d39.tar.gz
Doxygen-196c6ffa3310237b79a28e8f7ed94f2d61142d39.tar.bz2
Merge pull request #665 from albert-github/feature/bug_docu_files
Documentation corrections
-rw-r--r--doc/arch.doc4
-rw-r--r--doc/faq.doc4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/arch.doc b/doc/arch.doc
index e5fbbdc..337f4dd 100644
--- a/doc/arch.doc
+++ b/doc/arch.doc
@@ -139,8 +139,8 @@ strings and executes the commands it finds in it (this is the second pass
in parsing the documentation). It writes the result directly to the output
generators.
-The parser is written in C++ and can be found in src/docparser.cpp. The
-tokens that are eaten by the parser come from src/doctokenizer.l.
+The parser is written in C++ and can be found in \c src/docparser.cpp. The
+tokens that are eaten by the parser come from \c src/doctokenizer.l.
Code fragments found in the comment blocks are passed on to the source parser.
The main entry point for the documentation parser is \c validatingParseDoc()
diff --git a/doc/faq.doc b/doc/faq.doc
index bbad8c0..61d516b 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -210,7 +210,7 @@ remove the % and keep the word unlinked.
No, not as such; doxygen needs to understand the structure of what it reads.
If you don't mind spending some time on it, there are several options:
- If the grammar of X is close to C or C++, then it is probably not too hard to
- tweak src/scanner.l a bit so the language is supported. This is done
+ tweak \c src/scanner.l a bit so the language is supported. This is done
for all other languages directly supported by doxygen
(i.e. Java, IDL, C#, PHP).
- If the grammar of X is somewhat different than you can write an input
@@ -219,7 +219,7 @@ If you don't mind spending some time on it, there are several options:
Javascript, see http://www.stack.nl/~dimitri/doxygen/download.html#helpers).
- If the grammar is completely different one could write a parser for X and
write a backend that produces a similar syntax tree as is done by
- src/scanner.l (and also by src/tagreader.cpp while reading tag files).
+ \c src/scanner.l (and also by \c src/tagreader.cpp while reading tag files).
\section faq_lex Help! I get the cryptic message "input buffer overflow, can't enlarge buffer because scanner uses REJECT"