Finish documentation

[curds01]

This is an epic issue intended to serve as the focal point for all documentation related tasks that haven't been done yet.

As each of these tasks are completed, they'll be checked off (with some documentation as to what makes it "complete"). This issue will also be potentially edited to add more tasks as necessary.

Tasks

• Initial clean up based on new formatting standards. (Reflow documentation #127)
• Every element implementation is properly documented. To be properly documented this requires:
  • Full and meaningful class documentation.
  • The class documentation should have a properly formatted xml example explaining all xml parameters.
  • The implementation should be referenced in the corresponding element mark-down file.
  • Update documentation on Menge site so that it reflects the complete documentation in master.
  • Reduce redundant documentation
    • eliminate doxygen for obvious methods.
    • eliminate redundant documentation on overrides.
    • No doxygen errors
  • AgentGenerators
  • Elevations
  • ObstacleSets
  • ProfileSelectors
  • SpatialQueries
  • StateSelectors
  • Actions
  • Goals
  • GoalSelectors
  • Tasks
  • Transitions
  • Velocity components
  • Velocity modifies
• Document unique input files
  • Navigation mesh
  • Road map
• Document scb file format.
• Examples (see issue Set offset goal in cross case #106)
  • Each example will have a corresponding readme.md file discussing what features it features
  • A central markdown file will enumerate all examples.
  • Some mutual reference between featured element and example.
  • Videos of examples running (and links to those videos) (See Website should connect menge examples to videos #29)
• Concept documentation
  • Obstacles (see issue Invisible obstacle in pedModelSwap - obstacle documentation required #59, how to define obstacle set  #117 )
  • Extending Menge and the plugin architecture.
• Plugins

[chraibi]

Good luck with that mate. Is GiHub-Pages something for Menge?

[Bromeon]

Something I noticed when generating Doxygen, and you might want to consider when adding more documentation: a lot of the tags are not correctly parsed by Doxygen. I think it has to do with indentation of the @brief and @param tags in the code.

[curds01]

@Bromeon Thanks for calling that out. I'll make a concerted effort to render things at each stage to make sure the end result is desired. Up to this point, it's been produced review-free environment with a kind of fire-and-forget method. And the results of that are clear.