Documentation for Nana C++ Library
Contributed by qPCR4vir
A doxygen "offline" documentation. Build instructions:
1- Install Doxygen
2- Alongside with the folder of nana unzip or clone the repository nana-docs
3- and unzip or clone the repository for nana-demo
4- run doxygen with one of the .doxyfile projects provided in nana-docs
5- open and bookmark the locally generated web site.
This is an example of what you will get
A Wiki
Documenting nana
- Reference Manuals by Jin Hao.
- This Nana automatic documentation project. See an example here. To contribute:
- fork nana, directly edit doxygen comments in the source code and make a pull request to hotfix.
- fork nana-docs or nana-docs-fork and edit doxygen sources and request a pull. You can modify the .md files in this repository (for example: Getting Started. One of the possibilities: in your fork of nana-docs you edit the file and make a pull request).
- fork nana-demo and pull your own examples.
This is the information you will see in the Doxygen generated docs, that you can generate locally for your very personal branch and have it available off-line, or that you can navigate at Nana Doxy Docs online.
- Nana Wiki. Simple contribute at any time !!! It is easy. All need revision, but these pages need urgent update:
- [Installation] (https://github.com/qPCR4vir/nana-docs/wiki/Installation)- It need to be updated.
- Widgets
- brief description of each widget
- a sample picture with a link to the code example in nana-demo
- a link to the full description of each widget. It need to describe the functionality available from the GUI and the API for programers.
- Colors and schemes
- need creation
- How works?
- Events
- Stop propagation
- Emit
- Specialized events (listbox, treebox, etc.)
- listbox
- textbox
- tabbar
- Layot with
place- need creation
- examples
-
msgbox -
filebox- need creation !
-
Inputbox- need creation !
-
Paint - API
- need creation !
- etc.