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.08k stars 544 forks source link

missing part of documentation #673

Open efa opened 2 weeks ago

efa commented 2 weeks ago

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?

RobLoach commented 2 weeks ago

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

efa commented 2 weeks ago

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

efa commented 2 weeks ago

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