On 21 May 2013 02:50, Curtis Dutton <curtd...@gmail.com> wrote: > Now I'd like to add a manpage for the driver and any other documentation > where appropriate. I need some guidance on what documentation to add and > where to add it.
If (as the thread title suggests) the driver is written in "comp" then docs will be auto-generated from the comments in the comp file. You should put in a detailed description using the comp "description" tag. If you type man wj200_vfd you will see what it has produced. It might well prove to be both excessively brief, and possibly wrong. It is possible to play games with the text formatting, if you look at bldc.comp you will see that it produces different output for manpage and html docs. This was dome by jepler and I can't claim to really understand it. -- atp If you can't fix it, you don't own it. http://www.ifixit.com/Manifesto ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_may _______________________________________________ Emc-developers mailing list Emc-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/emc-developers
