This is well overdue.
As an outsider I find getting my head around the runtime complex.
This will help a lot.

> On 7 Feb 2017, at 00:26, Jon Purdy via Mono-devel-list 
> <[email protected]> wrote:
> 
> We’ve recently added initial support for building Doxygen documentation[1]. 
> The master docs are currently available on Jenkins[2]. We intend to set up a 
> central location online where these docs are deployed, as a convenient way to 
> browse the runtime code. My hope is that this helps new developers and people 
> unfamiliar with different parts of the runtime.
> 
> But first, many comments need to be updated to use Doxygen syntax in order to 
> produce useful docs. It wouldn’t be very productive for me to do all of this 
> myself, so I propose that when we change some code, we make sure that if the 
> code is documented, then its documentation appears correctly in the Doxygen 
> output.
> 
> I am not proposing that we write new documentation at this time, only verify 
> the docs we already have and get them ready for deployment.
> 
> You can also build the docs locally with “make doxygen -C docs” in the Mono 
> repository, then open “docs/doxygen-output/index.html” to view the results. 
> (This can take several minutes.)
> 
> Questions, comments, and objections are welcome. :)
> 
> [1]: https://github.com/mono/mono/pull/1383 
> <https://github.com/mono/mono/pull/1383>
> [2]: https://jenkins.mono-project.com/job/test-mono-mainline-staticanalysis 
> <https://jenkins.mono-project.com/job/test-mono-mainline-staticanalysis>/
> 
> _______________________________________________
> Mono-devel-list mailing list
> [email protected]
> http://lists.dot.net/mailman/listinfo/mono-devel-list

_______________________________________________
Mono-devel-list mailing list
[email protected]
http://lists.dot.net/mailman/listinfo/mono-devel-list

Reply via email to