Improving documentation

[pkrukp]

Hi,

I wonder if it's possible to somehow easily contribute to improve Cecil documentation.

One way would be to add documentation comments for classes and methods, but I've seen an issue about something similar that was closed because you're not sure you'll be able to maintain this documentation.

Then how about improving wiki - for example adding some simple examples.

One case would be for example:

• Add to HOWTO "reading method local variable names" with explanation that this information is part of debug information (pdb) so you need to enable reading this information and then you can cross reference MethodDefinition.Body.Variables (the Index property) with MethodDefinition.DebugInformation.Scope.Variables array.

(I hope I got it right. At least for me that was not obvious and I've spent some time googling, not to mention there was some old/incorrect information that suggested using PdbReaderProvider explicitly - which does not seems to be required in simple case)

I guess that if I continue using Mono.Cecil I would find more such not obvious things that could be added to wiki.

What's your opinion on that? I think anyone can edit wiki pages (just tested - it's possible). So I could just add such entry to the HOWTO. But as I'm not expert on Cecil, I think it'd be good for someone to review it. Adding wrong information might be worse that not having information at all ;) I have not seen any support for CR/pull request for the wiki... So maybe first start new discussion with proposed entry and then update wiki?