Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>For me the key considerations would be:</p> <ol> <li><p><strong>Fully automated:</strong> Can it be set up in such a way so that pretty much no outside work is required to create or edit the documentation.</p></li> <li><p><strong>Fully styled:</strong> Can the documentation be fully styled so that it looks great in a wiki or pdf after it’s generated. I should be able to change colors, font sizes, layouts, etc.</p></li> <li><p><strong>Good Filtering:</strong> Can I select only the items I want to be generated. I should be able to filter the namespaces, file types, classes, etc.</p></li> <li><p><strong>Customization:</strong> Can I include headers, footers, custom elements, etc.</p></li> </ol> <p>I found Doxygen could do all of this. <strong>Our workflow is as follows:</strong></p> <ol> <li><p>Developer makes a change to the code</p></li> <li><p>They update the documentation tags right above the code they just changed </p></li> <li>We click a generate button</li> </ol> <p>Doxygen will then extract all the XML documentation from the code, filter it to only include the classes and methods we want, and apply the CSS styling we’ve pre-made for it. Our end result is an internal wiki that looks the way we want, and doesn’t require editing.</p> <p><strong>Extra:</strong> We have all our projects in various git repositories. We pull all these down to one root folder and generate the docs form this root folder..</p> <p>Would be interested to know how others are automating even further..?</p>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
    2. VO
      singulars
      1. This table or related slice is empty.
    3. VO
      singulars
      1. This table or related slice is empty.
    1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload