[cfe-dev] Notes on Doxygen documentation style

[Piotr Rak]

Hi Chris,

2009/1/20 Chris Lattner <clattner at apple.com>:
>
> On Jan 20, 2009, at 9:46 AM, Douglas Gregor wrote:
>
>> Architectural Descriptions
>> ====================
>>
>> We currently have a Clang "internals" manual, with documentation about
>> various subsystems within Clang:
>>
>>   http://clang.llvm.org/docs/InternalsManual.html
>>
>> We could consider bringing this documentation in with the rest of the
>> Doxygen documentation using, e.g., Doxygen's \page and \newpage
>> markup. The benefit of bringing all of the internals documentation
>> into Doxygen is that we can more easily cross-link between specific
>> function/class documentation and the more general, architectural
>> information.
>
> This is one thing that I don't agree with.  I think it is fine to link
> from the internals manual to the doxygen (we do this in other LLVM
> dox) just using normal links.  "Hiding" the documentation in the code
> makes it harder to find IMO.

This is ok, as long url mangling doesn't change between Doxygen versions.
I am not sure, if it is case or not.
How about, putting internals manual in some lets say *.doc files,
inline html there, and adjust Doxygen's config to include those files?

Piotr

> -Chris
> _______________________________________________
> cfe-dev mailing list
> cfe-dev at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev
>