Hello Folks,
We want to document symbols which aren’t declared in the code, such as
environment variables and preprocessor symbols declared by the build system.
There doesn’t seem to be an easy way to do this.
For example, @var doesn’t generate output if the symbol doesn’t appear
somewhere in
Hello Folks,
I need to escape the sequence `*/‘ inside a code block.
For example, consider a shell command with wildcards:
\code $ ls foo*/ \endcode
The problem, of course, is this is in a C/C++ file, so the delimiter for the
Doxygen comment block is `/** … */‘. The compiler sees the `*/‘ in t
Hello Folks,
I want to link to an overloaded function with this signature:
Functor(void(*function)(void));
Because Functor is overloaded, I have to give the full signature, but I can’t
figure out how doxygen wants it expressed. I’ve tried all of these:
@see Functor(*)
@see Functor((*))
Hello Folks,
I’m having problems with documenting friends in C++.
doxygen-1.8.10
WARN_IF_UNDOCUMENTEDYES
WARN_IF_DOC_ERROR YES
WARN_NO_PARAMDOCYES
DISTRIBUTE_GROUP_DOCYES
EXTRACT_ALL no
This file produces three warnings, as listed in the comments, but only when
Hello Folks,
I need help configuring Doxygen to generate warnings on *any* undocumented
items.
There are a few cases which seem to pass without warnings, despite the obvious
Doxyfile config options. There are other cases which generate warnings for
parameters and return values, but only if
Hello Folks,
I upgraded by doxygen to 1.8.9.1 from the sources. (Mac 10.8.5, gcc 4.2.1).
Then I protected some of my comments in our doxygen.conf using '##', for
example:
> ## -*- sh -*-
>
> ...
>
> ALIASES=
>
> ## Link to bug tracker
> ALIASES += bugid{1}="
Hello Folks,
When I have a class declared *inside* a function, the docs for the class and
members get merged into the function docs. Instead I expect the internal class
to be documented separately, just a class declared within another class.
Here's a minimal example, declaring an API with an a
Hello Stephan,
We[1] use a combination of doxygen (for API) and Sphinx[2] for more expository
docs, such as tutorial and manual. In particular, it's straightforward Sphinx
to integrate portions of an example program along with the output. Sphinx uses
make to generate the documentation, so it'
Hello Folks,
The generated html labels functions by access specifier, as in:
static struct Resolution* ns3::Time::PeekResolution (void) inline static read
private
(C++ example taken from ns-3:
https://www.nsnam.org/docs/doxygen/classns3_1_1_time.html#a0b023c55c20582aa7c1781aacf128034
)
"inli
Hello Folks,
Is it possible to specify the source language in a Doxygen comment itself?
Use case: we have several files *without* standard extensions, and differing
languages. The file names can't be changed. While
EXTENSION_MAPPING = no_extension=x
can be used to fix one of the
10 matches
Mail list logo