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.22k stars 560 forks source link

Offer: willing to document #696

Open quadroli opened 4 weeks ago

quadroli commented 4 weeks ago

Hellooo 👋 I'm down to document the user facing api of Nuklear I've noted that not all functions are documented and the documentation is split across the wiki and the website ... Hence I would like to bring it all together to something coherent. Hence I'd like to know what efforts are being made towards this to see where I can help or how y'all envision this should be done

RobLoach commented 3 weeks ago

Would love some help on the documentation. Two things I can think of...

  1. The Wiki docs could expand https://github.com/Immediate-Mode-UI/Nuklear/wiki
  2. The inline documentation could improve too, have been thinking of making a move to Doxygen for the comments
Xeverous commented 2 weeks ago

@quadroli do you have any notes already? I'm interested in nk_widget and nk_list_view_begin - these functions are not documented at all and the second one is not used in any example.

quadroli commented 2 weeks ago

I see, I'll pay close attention to those two No, I do not have notes ready just yet

awschult002 commented 3 days ago

I use doxygen a lot. If you want, I can give the project a quick conversion and get a PR up for some initial feedback. I think moving to something g like doxygen and having the inoine comments sync with the website would help a lot

quadroli commented 3 days ago

@awschult002 💯 I second that That would be awesome, @RobLoach would love that too

Xeverous commented 3 days ago

I'm writing a C++ wrapper library for Nuklear. I'm also using Doxygen. If Nuklear moved to it, I could have one documentation for both libraries in one place. That would be great.

awschult002 commented 1 day ago

i am starting on the Doxygen stuff now. but i do have some questions on how the group would like to move forward. The existing documentation structure is not exactly how doxygen expects the information to be laid out. That isn't to say that doxygen cannot handle what currently exists; but I think restructuring comments a little bit and moving a lot of the information in nuklear.h into the separate source files would be more beneficial. This, however, would require me to start moving and copying stuff into many of the other source files and could end up creating huge merge conflicts with any existing PRs.

How much change is the project willing to take on for this update? ( i personally think it is worth it). How much change/input does the group want before the initial merge/switch to doxygen? do you want everything to move over with as much change as necessary? or do you want a minimal change right now and slowly start to integrate or migrate?

awschult002 commented 1 day ago

@quadroli @RobLoach @Xeverous I have kicked off a doxygen PR. Please take a look.

https://github.com/Immediate-Mode-UI/Nuklear/pull/722