I found out that there's 'remarks' tag where large comment part can be put.
I just can't remember what docs generator can parse these xml comments.
Will there be some kind of html docs to the OpenHTM code?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Here are the Sandcastle docs (created in Sandcastle of course). You can get an idea of the quality of the generated help by looking at the Sandcastle manual. I have no idea how much extra work it is to get to this level of documentation, but if we run Sandcastle on the existing project and we like what we see, let's use it. Anyone want to give it a try?
I agree Nick. Most of the methods in the CLA package have pretty good doc but I did notice lots of Region properties were not documented so I added some good descriptions to each of those as I was updating the unit tests. I know there are a few more properties without doc and I will be sure to finish up the rest as I revisit things.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I found out that there's 'remarks' tag where large comment part can be put.
I just can't remember what docs generator can parse these xml comments.
Will there be some kind of html docs to the OpenHTM code?
I think there should be a documentation. Sandcastle is doing this for example
I was searching for a modern free doc generator which would use .net tags but didn't find anything useful.
Last edit: Nick 2013-03-23
Now I got it: Sandcastle is a software you have found:)
Thanks, Uwe!
Here are the Sandcastle docs (created in Sandcastle of course). You can get an idea of the quality of the generated help by looking at the Sandcastle manual. I have no idea how much extra work it is to get to this level of documentation, but if we run Sandcastle on the existing project and we like what we see, let's use it. Anyone want to give it a try?
http://www.ewoodruff.us/shfbdocs/?topic=html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm
I'll try that
So docs look like this, just open the index.html.
It can be made in chm format if you guys want
Last edit: Nick 2013-04-05
Guys, please try to make more documentation comments in your code!
I agree Nick. Most of the methods in the CLA package have pretty good doc but I did notice lots of Region properties were not documented so I added some good descriptions to each of those as I was updating the unit tests. I know there are a few more properties without doc and I will be sure to finish up the rest as I revisit things.