You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Now that we have modules, let's document them! This task is to make a studoc program to parse module files and extract the following information:
Module name
Module doc string
All defun'd functions, their doc strings and their argument formals
All defmacro'd macros + their doc strings
All def'd things
Once the above information is extracted, we can output the info in various formats:
POD formatted documentation, so we can generate HTML & man pages for each module
S-expressions so it can be processed by other programs easily
Maybe other specific options to just output specific bits
For example:
$ studoc --module mymod.stu --output pod # To output POD documentation to stdout
$ studoc --module mymod.stu --output sexp # To output S-expressions
$ studoc --module mymod.stu --modname # Specificly dump the module name
my-mod-name
$ studoc --module mymod.stu --functions
my-func-1
my-func-2
$ studoc --module mymod.stu --functions --docstrings
my-func-1 - First function documention
my-func-2 - See above function
Perhaps the --module option could search the interpreter include path, in which case the resolution logic needs to be slightly refactored/moved around.
The text was updated successfully, but these errors were encountered:
Now that we have modules, let's document them! This task is to make a studoc program to parse module files and extract the following information:
defun
'd functions, their doc strings and their argument formalsdefmacro
'd macros + their doc stringsdef
'd thingsOnce the above information is extracted, we can output the info in various formats:
For example:
Perhaps the
--module
option could search the interpreter include path, in which case the resolution logic needs to be slightly refactored/moved around.The text was updated successfully, but these errors were encountered: