Hi Carsten,
Carsten Neumann wrote:
>
> as discussed in ticket #69 I'm currently moving the documentation for
> generated containers into the *Base.cpp files. I now noticed that there
> are containers that have documentation in the .cpp that is not generated
> from the .fcd, so I'll move it there.
Great, thanks!
> The issue I'm facing now is the formatting of the description text,
> should I take it verbatim from the .fcd (and maybe improve it there
> while I'm at it) ?
I think that would be the best solution. Doxygen will reformat it anyway, so
whatever is easy to edit in the .fcd should be ok.
> What do people use to write .fcd files and how does it affect the
> formatting of descriptions ?
Persoanlly I just is e asimple editor, but I'm old-fashioned. ;)
> Should the descriptions in .fcd files be moved into <![CDATA[ ]]>
> sections ?
I don't think that's necessary, as AFAICS the doxygen elements that make sense
to be used in class docs don't interfere with XML standards. I might be wrong
about this one, though.
Dirk
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Opensg-core mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/opensg-core
