Documentation - Githubissues

Oxsomi / core3

Oxsomi Core3 is a combination of standalone C libraries useful for building applications, such as types, platform, graphics abstraction and file formats

GNU General Public License v3.0

0 stars 1 forks source link

Documentation #8

Open Nielsbishere opened 2 years ago

Nielsbishere commented 2 years ago

We probably want to do this in the .c files with some tool that parses our documentation from there. I don't want to polute .h files because they're like a blueprint of the class and it's nicer to keep an overview without code and lots of comments in there.

[x] code_style
[ ] types
[x] formats/oiCA
[x] formats/oiDL
[x] formats/oiXX
[x] formats/oiSH
[ ] formats/oiSB
[ ] formats/DDS, wav, bmp
[ ] formats
[x] platforms
[ ] graphics api
[X] graphics spec
[ ] shader compiler
[ ] OxC3 tool
[ ] Audio

Nielsbishere commented 10 months ago

Types docs:

[x] BigInt
[x] math.h
[x] pack.h
[x] type_cast.h
[x] Vectors
[x] AllocationBuffer
[x] BufferLayout
[x] Basic file util
[x] Transform
[x] Quaternions
[x] Buffer
[ ] CharString
[ ] GenericList
[x] Atomic
[x] Lock
[x] Log
[x] Thread
[x] RefPtr
[ ] Lexer
[ ] Parser
[ ] File streams

Platforms docs:

[x] File
[x] InputDevice
[x] Keyboard / Mouse
[x] Monitor
[x] Platform
[x] Window
[x] WindowManager
[x] Ext functions

Format docs:

[x] ETextureFormat
[x] BMP
[x] oiDL
[x] oiCA
[x] oiSH