[Tracking] NifSkope API Documentation

[hexabits]

Task List

• [ ] Remove hacking.h
• [ ] Use Markdown file as main page plus all other non-source documentation.
• [ ] Create high level overview of application structure
  • [ ] Viewport programming
  • [ ] UI programming

    No Documentation

    Headers

• gl/glmarker.h
• gl/glnode.h
• gl/glparticles.h
• gl/glscene.h
• importex/3ds.h
• spells/transform.h
• widgets/nifcheckboxlist.h
• widgets/nifeditor.h
• widgets/xmlcheck.h (almost no)
• kfmmodel.h
• message.h
• nifexpr.h
• nifproxy.h
• nvtristripwrapper.h

  Source

[WIP]

Insufficient Documentation

Headers

[WIP]

Source

[WIP]

[hexabits]

I've finally started on this.

hacking.h has been removed and replaced with doxygen.md. The main page uses this MD file as well as additional pages. Uses USE_MDFILE_AS_MAINPAGE in the Doxyfile.

I'm currently writing up a large amount of documentation covering the program structure and function in the MD file.

[hexabits]

Initial commit can be seen at jonwd7/nifskope@44e5159 ... or more easily you can view the MD file with the proper formatting here: https://github.com/jonwd7/nifskope/blob/dev/2.0/DOXYGEN.md

(Note: GitHub does not support some of the Markdown extensions that Doxygen does, like the {#heading} targets)

Very basic initial overview of some parts of the program. I will slowly flesh out the documentation for other parts of the program.

Doing so has already highlighted some issues with the current program structure which I will end up refactoring, such as the weird Node -> Mesh inheritance. Ideally Node and Mesh should be siblings and there should be a more basic abstract class for all physical objects in the scene, to more closely mimic the NiAVObject inheritance present in nif.xml.

[hexabits]

Here is what the actual Doxygen documentation looks like:

The "Viewport" page for example.

Doxygen uses the @page syntax to define something as its own page, so all of the documentation pages can be included in the one DOXYGEN.md file.

[neomonkeus]

I would not worry too much about the github markup as this is internal documentation. Unless you want to generate a markup compatible version too

[hexabits]

@neomonkeus GitHub and Doxygen both use Markdown, but Doxygen supports various Markdown Extensions that GitHub does not, so I was just bringing up the fact that the MD files will look a bit odd when viewed on here. Like the {#} in the headings and the [TOC] link.