Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
D
doxverilog
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
Elphel
doxverilog
Commits
b4553081
Commit
b4553081
authored
Aug 18, 2013
by
Dimitri van Heesch
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #21 from albert-github/feature/docu
Feature/docu
parents
8ec46cbd
f53e636e
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
14 additions
and
8 deletions
+14
-8
.gitignore
.gitignore
+3
-0
markdown.doc
doc/markdown.doc
+3
-0
preprocessing.doc
doc/preprocessing.doc
+8
-8
No files found.
.gitignore
View file @
b4553081
...
@@ -73,3 +73,6 @@
...
@@ -73,3 +73,6 @@
/doc/Makefile
/doc/Makefile
/doc/translator_report.txt
/doc/translator_report.txt
/examples/*/html
/html
/latex
doc/markdown.doc
View file @
b4553081
...
@@ -283,6 +283,9 @@ To create a link to an URL or e-mail address Markdown supports the following
...
@@ -283,6 +283,9 @@ To create a link to an URL or e-mail address Markdown supports the following
syntax:
syntax:
<http://www.example.com>
<http://www.example.com>
<https://www.example.com>
<ftp://www.example.com>
<mailto:address@example.com>
<address@example.com>
<address@example.com>
Note that doxygen will also produce the links without the angle brackets.
Note that doxygen will also produce the links without the angle brackets.
...
...
doc/preprocessing.doc
View file @
b4553081
...
@@ -20,7 +20,7 @@ Source files that are used as input to doxygen can be parsed by doxygen's
...
@@ -20,7 +20,7 @@ Source files that are used as input to doxygen can be parsed by doxygen's
built-in C-preprocessor.
built-in C-preprocessor.
By default doxygen does only partial preprocessing. That is, it
By default doxygen does only partial preprocessing. That is, it
evaluates conditional compilation statements (like \#if) and
evaluates conditional compilation statements (like \
c \
#if) and
evaluates macro definitions, but it does not perform macro expansion.
evaluates macro definitions, but it does not perform macro expansion.
So if you have the following code fragment
So if you have the following code fragment
...
@@ -75,14 +75,14 @@ the \ref cfg_predefined "PREDEFINED" or
...
@@ -75,14 +75,14 @@ the \ref cfg_predefined "PREDEFINED" or
\ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tag.
\ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tag.
A typically example where some help from the preprocessor is needed is
A typically example where some help from the preprocessor is needed is
when dealing with
Microsoft's __declspec language extension
. The same goes
when dealing with
the language extension from Microsoft: \c __declspec
. The same goes
for GNU's __attribute__ extension. Here is an example function.
for GNU's
\c \
__attribute__ extension. Here is an example function.
\verbatim
\verbatim
extern "C" void __declspec(dllexport) ErrorMsg( String aMessage,...);
extern "C" void __declspec(dllexport) ErrorMsg( String aMessage,...);
\endverbatim
\endverbatim
When nothing is done, doxygen will be confused and see __declspec as
When nothing is done, doxygen will be confused and see
\c
__declspec as
some sort of function. To help doxygen one typically uses the following
some sort of function. To help doxygen one typically uses the following
preprocessor settings:
preprocessor settings:
...
@@ -93,10 +93,10 @@ EXPAND_ONLY_PREDEF = YES
...
@@ -93,10 +93,10 @@ EXPAND_ONLY_PREDEF = YES
PREDEFINED = __declspec(x)=
PREDEFINED = __declspec(x)=
\endverbatim
\endverbatim
This will make sure the __declspec(dllexport) is removed before doxygen
This will make sure the
\c
__declspec(dllexport) is removed before doxygen
parses the source code.
parses the source code.
Similar settings can be used for removing __attribute__ expressions from the input:
Similar settings can be used for removing
\c \
__attribute__ expressions from the input:
\verbatim
\verbatim
ENABLE_PREPROCESSING = YES
ENABLE_PREPROCESSING = YES
...
@@ -127,7 +127,7 @@ DECLARE_INTERFACE(IUnknown)
...
@@ -127,7 +127,7 @@ DECLARE_INTERFACE(IUnknown)
\endverbatim
\endverbatim
without macro expansion doxygen will get confused, but we may not want to
without macro expansion doxygen will get confused, but we may not want to
expand the REFIID macro, because it is documented and the user that reads
expand the
\c
REFIID macro, because it is documented and the user that reads
the documentation should use it when implementing the interface.
the documentation should use it when implementing the interface.
By setting the following in the config file:
By setting the following in the config file:
...
@@ -183,7 +183,7 @@ class QListT
...
@@ -183,7 +183,7 @@ class QListT
\endverbatim
\endverbatim
Then the only way to get doxygen interpret this as a class definition
Then the only way to get doxygen interpret this as a class definition
for class QList is to define:
for class
\c
QList is to define:
\verbatim
\verbatim
PREDEFINED = QListT:=QList
PREDEFINED = QListT:=QList
\endverbatim
\endverbatim
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment