Nuklear icon indicating copy to clipboard operation
Nuklear copied to clipboard

missing part of documentation

Open efa opened this issue 1 year ago • 5 comments

the nuklear.h file report this docs index:

/// ## Contents
...
/// 6. API section
///     1. Context section
///     2. Input section
///     3. Drawing section
///     4. Window section
///     5. Layouting section
///     6. Groups section
///     7. Tree section
///     8. Properties section
/// 7. License section
...

and the generated Nuklear/doc/index.html is the same, but nuklear.h prototype between 6.7 and 6.8 list those sub-chapters too:

    Tree

    LIST VIEW
    WIDGET
    TEXT
    BUTTON
    CHECKBOX
    RADIO BUTTON
    SELECTABLE
    SLIDER
    PROGRESSBAR
    COLOR PICKER

    Properties

those sub-chapters are hard find if not studying the whole header. Can you please fix the documentation?

efa avatar Aug 30 '24 20:08 efa

The documentation could definitely be improved. Been wanting to move to doxygen for a while too.

RobLoach avatar Aug 31 '24 04:08 RobLoach

and the online docs does not help for those widgets: https://github.com/Immediate-Mode-UI/Nuklear/wiki

efa avatar Aug 31 '24 10:08 efa

the last part differ from nuklear.h index and locally generated Nuklear/doc/index.html Here between Properties and License, I have:

    Properties

    Font
    Memory Buffer
    Text Editor
    Drawing
    Stack
    Math
  Sqrt
  Sine/Cosine

  License

but in reality the full API has more:

    Properties

    TEXT EDIT
    CHART
    POPUP
    COMBOBOX
    ABSTRACT COMBOBOX
    CONTEXTUAL
    TOOLTIP
    MENU
    STYLE
    COLOR
    IMAGE
    9-SLICE
    MATH
    STRING
    UTF-8

    Font
    Memory Buffer
    Text Editor
    Drawing
    INPUT
    Stack
    Math
  Sqrt
  Sine/Cosine
  License
  Changelog
  Gallery
  Credits

I understand nuklear.h head in not updated, but I do not know why the Makefile for docs do not get all of those widgets

efa avatar Aug 31 '24 11:08 efa

big doxygen update is incoming. dox might be broken for a little bit. once the Doxygen PR is complete, I will try to circle back here.

awschult002 avatar Nov 18 '24 15:11 awschult002

Hi, I am unsure that you already aware of : the current generated documentation have an emtpy "API" chapter here : https://immediate-mode-ui.github.io/Nuklear/index.html#autotoc_md10 Which seems to be quite confusing for the newcomer I am. Maybe an easy step is add a sentence to say where to go in the source or headers if this doxygen part isn't finished yet ?

I have hard time to find another information : is Nuklear is a good match for an SDL3 project that aims to provide a C plugin API which want to provide core program hooks and facilities to plugin programmers to add some UI panels dedicated to their plugin into the main program UI. Think "like OBS Studio plugins but without C++ and QT mess in plugin linking".

Thanks for all the fish !

ludolpif avatar Nov 21 '25 20:11 ludolpif