Hi Ralph,
On 12/13/2017 01:57 AM, Ralph Lange wrote:
> Follow-up to yesterday's meeting:
>
> If you look at the end of this paragraph
> https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands
> the file extensions for other files that may contain Doxygen blocks to
> be included in the generated documentation, while being excluded from
> the file list may be .dox, .txt or .doc
>
> So - that would make .dox appropriate for files that contains only
> Doxygen blocks, while restructured text (that we were talking about
> IIRC) should probably have .txt.
I do like .dox for text intended for doxygen. However we publish Release
Notes as separate stand-alone files so they don't belong in a .dox file.
I want us to to do some unification of our in-tree documentation across
the different modules for the next release so this will be useful for
that (I'm not advocating making any changes before the final 7.0.1 though).
I also want us to generate Doxyfiles by expanding macros in them (mostly
for file paths and version numbers) — I did some work on that earlier in
the year, but it may need a bit of re-thinking to handle submodules
properly.
- Andrew
--
Arguing for surveillance because you have nothing to hide is no
different than making the claim, "I don't care about freedom of
speech because I have nothing to say." -- Edward Snowdon
- References:
- Doxygen documentation outside source files Ralph Lange
- Navigate by Date:
- Prev:
converting strings to integer Dirk Zimoch
- Next:
Re: converting strings to integer Andrew Johnson
- Index:
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
<2017>
2018
2019
2020
2021
2022
2023
2024
- Navigate by Thread:
- Prev:
Doxygen documentation outside source files Ralph Lange
- Next:
converting strings to integer Dirk Zimoch
- Index:
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
<2017>
2018
2019
2020
2021
2022
2023
2024
|