search

Immediate-Mode-UI / Nuklear

A single-header ANSI C immediate mode cross-platform GUI library
https://immediate-mode-ui.github.io/Nuklear/doc/index.html
Other
9.06k stars 542 forks source link

Documentation does not contain font section #535

Closed rongcuid closed 1 year ago

rongcuid commented 1 year ago

Font related API are not included in the documentation site, but apparently inside the actual header. Maybe there is an option not turned on?

Also, it would be nice if there is a more complete example in the documentation itself.

dumblob commented 1 year ago

Long story short: PRs very much welcome! (wiki edits are without PRs whatsoever and without discussion - in case of vandalism, we simply revert it)

Yes, we have pretty comprehensive font wiki but I am afraid it is too much to put in the source code inline doc. Or maybe I am wrong. IDK

OTOH it is true that it would be better to have just one "comprehensive source of truth". Any ideas how to approach it? Feel free to make a PR and we will discuss the specific points there. Or just edit the wiki - no need for discussion :wink:.

rongcuid commented 1 year ago

It's not really a single source of truth that is the hardest part of learning Nuklear, it is that documentations don't give a comprehensive, high-level overview of how Nuklear is actually used and its lifecycle. For instance, what does initialization look like? In a program (say, a render loop), what part of Nuklear is called in what order? (Like defining the GUI and states? Converting Nk commands to vertex/index buffers? Getting textures from somewhere?)

Though, this issue is mostly about the fonts documentation being present in nuklear.h but not generated in the documentations. There might be a switch turned off, or something. I am not familiar with Doxygen. I think this is quite important because the Quick Start section includes a reference to fonts (in init code), but relevant documentation are not in the same page.

dumblob commented 1 year ago

Oh, for the general purposes you describe we definitely welcome PRs improving the documentation.

We have a very comprehensive set of example apps and backends (called "demos") - they show exactly what you are asking. Feel free to improve them or write documentation following the demos & examples.

Generally header-only libraries tend to strongly prefer one to read the source instead of documentation, so that is why we have mostly code in this repo :wink:.

rongcuid commented 1 year ago

What's blocking the merge?

dumblob commented 1 year ago

Our time to review (usually weeks to months). If others could chime in, it will be merged much quicker.

We would be more than happy to give you merge/admin rights. We just need you to first thoroughly review maybe two other PRs (more is always welcome :wink:).

rongcuid commented 1 year ago

Do I need permission to review? Or is it just commenting?

dumblob commented 1 year ago

Do I need permission to review? Or is it just commenting?

You do not need anything - just go ahead! We will very much appreciate it!