Comments (5)
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.
from nifskope.
Initial commit can be seen at hexabits/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.
from nifskope.
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.
from nifskope.
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
from nifskope.
@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.
from nifskope.
Related Issues (20)
- Starfield support (PSA) HOT 58
- Export collision mesh?
- MacOS version not displaying texture HOT 2
- Editing BSTriShape vertex desc for a skinned mesh does not update the vertex desc in its NiSkinPartition HOT 4
- i cant import obj HOT 1
- FAILED TO LOAD .INF HOT 1
- BSFurnitureMarkerNode markers display as rotated in the wrong direction HOT 7
- Status Homepage and Discord? HOT 6
- Cmake
- Error saving mesh - Failed to write block bhkCompressedMeshShapeData HOT 1
- Shortcuts in Nifskope
- Feature Request: Ability to copy and paste Starfield mesh sub-record / tree HOT 2
- Fails to load .INF file HOT 1
- Possible Bug
- Compilation error in GLI
- Moved to a different drive, won't open .nifs anymore HOT 1
- Support for Davilex Games
- Nifs are all invisible HOT 1
- MacOS version HOT 1
- Batch normals update HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nifskope.