[Mono-dev] mdoc update for a non-public types

Jonathan Pryor jonpryor at vt.edu
Thu Oct 24 19:26:29 UTC 2013


On Oct 24, 2013, at 7:38 AM, xplicit <svg at ngs.ru> wrote:
> Can anyone explain is this normal behaviour or not?

The primary "world view" for mdoc is for generating and maintaining "external" documentation:

	http://jprl.com/Blog/archive/development/mono/mdoc/#entry-development-mono-mdoc-2010-01-08T09:22:00AM

mdoc will generate "documentation stubs" which are later edited (typically by-hand, at least for me...). It does this by enumerating over all types and all members in the assembly, and generating mdoc(5)[0] XML for each type found.

Implicit in this worldview is that mdoc should _only_ process public or protected members, because generating documentation stubs for private members is lunacy.

Importing documentation (`mdoc -i ...`) doesn't change the above worldview: non-public/protected types are skipped before mdoc checks to see if it can import documentation for the member.

Furthermore, mdoc will _remove_ <Member/> nodes for members that aren't found in the type, so manually adding private members afterward won't fix it.

 - Jon



More information about the Mono-devel-list mailing list