Re: Documenting conceptual functions

Ron W <[email protected]>
Newsgroups gmane.text.doxygen.general
Message-ID <CAHWyCX5ex85pkmuK+cFP9NvzfnmBQKUJZH2mtyMqvxLhFJ+WxA@mail.gmail.com>
On Fri, Jul 21, 2017 at 8:17 AM, <
[email protected]> wrote:
>
> Date: Thu, 20 Jul 2017 14:19:29 +0000
> From: "Zieg, Mark (KSC-ESC-624)[SGT - ESC]" <[email protected]>
> Subject: [Doxygen-users] Documenting conceptual functions
>
> I know Doxygen has keywords like @brief, @param and @return to document
> functions.  Is there something like @function to create a "fake function"
> that those keywords can then decorate?  I tried using @fn, but got
> "Warning: documented function was not declared or defined," and no
> documentation was generated.
>

 That's the only one I've ever found.

@par could be used to created a titled paragraph, but would not generate
any kind of index entry.

@xrefitem will create both a titled paragraph and entries on an index page
with a specified title. I think this is the closest you can get to what you
are asking for.

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.