c# - Use separate file to extend documentation -
i using doxygen document huge projects written in c#. existing documentation in these projects should not changed.
is there way extend existing documentation , provide doxygen commands classes or methods in separate file?
for example, lets there class viewmodel.cs, documented this:
/// <summary> /// defines viewmodel can bound treelist control. /// </summary> public abstract class viewmodel : iviewmodel { /// <summary> /// gets root elements displayed in treelist. /// </summary> public observablecollection<itreenode> elements { get; protected set; } }
is there way create separate file (.dox) linked class , extends existing documentation? e.g. group class specific module \ingroup command.
to knowledge, no such tool exists. c# uses assemblies , namespaces conceptual grouping of apis. defining manual grouping separately serve confuse users familiar language.
for best results, should use c# documentation comments along latest release of sandcastle file builder or my fork of project (which uses different presentation style). these tools more cleanly integrated visual studio, , work continues on features intellisense extensions , code completion within documentation comments (roslyn+shfb quite still want see further improved). following page shows recent documentation build using latter:
Comments
Post a Comment