Re: documentation for code

+1 Great idea. On 3/5/16, 11:46 AM, "Aditi" wrote: > > >On Mar 5, 2016, at 11:10 AM, Sterling Hughes >> We have a regression test framework. Perhaps we can make samples in >>the documentation into regression tests, and mark them with a tag (e.g.

Re: documentation for code

>>some way to get that from the actual header files. The amount of >>copying from code to documentation led me to think that it will become >>increasingly difficult to get documentation that truly matches the code. >> My preference was to link to the code header file directly

documentation for code

I was writing some documentation today for the hal Apis and had a feeling that we are making work for ourselves. Documentation of the interface is important, but I wish we could have some way to get that from the actual header files. The amount of copying from code to documentation led me