sanine/honey-core
sanine/honey-core
1
3
Fork 1
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity

Document bindings #2

New issue
Open
opened 2023-05-29 22:45:34 +00:00 by sanine · 2 comments
sanine commented 2023-05-29 22:45:34 +00:00
Owner
Copy link

The bindings provided by the honey interpreter are currently completely undocumented, which is not helpful! This may be programmatically generated documentation from comments or hand-written documentation; either works.

The bindings provided by the honey interpreter are currently completely undocumented, which is not helpful! This may be programmatically generated documentation from comments or hand-written documentation; either works.
sanine added reference doc 2023-05-30 03:49:24 +00:00
sanine commented 2023-05-30 03:50:40 +00:00
Author
Owner
Copy link

i've started writing a doxygen-style utility to generate documentation from the comments in the doc branch.

i've started writing a doxygen-style utility to generate documentation from the comments in the `doc` branch.
sanine commented 2023-07-09 09:02:23 +00:00
Author
Owner
Copy link

the moonflower documentation utility now exists & works (mostly (probably (i wrote it in a bit of a haze))). to use it:

  1. specify files to process in the doc/moonflower/moonflower.conf file
  2. run doc/moonflower/moonflower.lua to generate documentation in doc/

the comment format that moonflower uses is moderately well documented by the comments around

Line 295 in sanine/moonflower@9eb0df5
if tag.name == 'module' then

; alternately, take a peek at src/opengl/data.c or src/glm/vec4.c where i've already started writing doc comments to get a feel for how they work.

the moonflower documentation utility now exists & works (mostly (probably (i wrote it in a bit of a haze))). to use it: 1. specify files to process in the doc/moonflower/moonflower.conf file 2. run doc/moonflower/moonflower.lua to generate documentation in doc/ the comment format that moonflower uses is moderately well documented by the comments around https://git.cyberia.club/sanine/moonflower/src/commit/9eb0df5237a059b855b1c9ba7062660c9a32c1ca/moonflower.lua#L295 ; alternately, take a peek at src/opengl/data.c or src/glm/vec4.c where i've already started writing doc comments to get a feel for how they work.
Sign in to join this conversation.
doc
Branches Tags
Clear current reference
main
doc
Clear current reference
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: sanine/honey-core#2
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?