-
-
Notifications
You must be signed in to change notification settings - Fork 267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Initial commit to rework docs #2116
base: master
Are you sure you want to change the base?
Conversation
You are modifying libf3d public API! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions could not be made:
- application/F3DStarter.cxx
- lines 1917-1918
- library/src/interactor_impl.cxx
- lines 802-810
- lines 863-864
- lines 873-875
- lines 910-911
- library/testing/TestSDKInteractorCommand.cxx
- lines 97-99
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions could not be made:
- application/F3DStarter.cxx
- lines 1917-1918
- library/src/interactor_impl.cxx
- lines 802-810
- lines 863-864
- lines 873-875
- lines 910-911
- library/testing/TestSDKInteractorCommand.cxx
- lines 97-99
Let's discuss in general is it good/bad approach before actually going for tests/other checks which will fail |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions could not be made:
- library/src/interactor_impl.cxx
- lines 909-910
Initial change for potential rework.
commands_doc.h
file is added. It contains:struct InteractiveCommand
which is new alternative to previously onlystd::function
, now it isstd::function
to do the command and documentation (strings describing function and arguments).struct InteractiveCommandDoc
templated byN
(number of arguments), it basically stores all constant fields of documentation for every function (basically allstd::string
data associated). Probably some way to handle variable number should be added somehow later on (not by template but by naming argument in doc in some specific way).List of constexpr objects of
struct InteractiveCommandDoc
for every function (except for one defined in tests, which are defined on the spot).templated
makeCommand
function to createstruct InteractiveCommand
given struct InteractiveCommandDocand
std::function` callback for the commandAnd I basically replaced storing callbacks only in map of commands into storing
struct InteractiveCommand
objects (doc+callback).I used chatgpt for some code genaration (to make boilerplate alternatives to old addCommand, needs to be checked)