Thingiverse
OpenSCAD Module_Help
von txoof
20
Downloads
16
Likes
0
Makes
I got tired of cracking open libraries that I wrote and trying to decipher the comments and documentation that I left for myself. Instead, I thought it would be nice if I could just `use ` and then call `help_libraryName()` to get a list of the available functions and module calls.
This is an attempt to add a standardized way of documenting modules.
The current version will be hosted on Git Hub: https://github.com/txoof/module_help
Add the module help_YourLibraryNameHere() {} to your OpenSCAD library to provide some
callable help.
Usage from an imported library:
//provide a list of all help topics in the "colors" library:
use
help_colors();
//output:
ECHO: "Available Help Topics in this Library:"
ECHO: "colorArray"
ECHO: "chord"
ECHO: "RGB"
ECHO: "RGBScale"
ECHO: "red"
ECHO: "redScaled"
//get help on a particular topic from the "colors" library:
help_colors("colorAray");
//output:
ECHO: "He
This is an attempt to add a standardized way of documenting modules.
The current version will be hosted on Git Hub: https://github.com/txoof/module_help
Add the module help_YourLibraryNameHere() {} to your OpenSCAD library to provide some
callable help.
Usage from an imported library:
//provide a list of all help topics in the "colors" library:
use
help_colors();
//output:
ECHO: "Available Help Topics in this Library:"
ECHO: "colorArray"
ECHO: "chord"
ECHO: "RGB"
ECHO: "RGBScale"
ECHO: "red"
ECHO: "redScaled"
//get help on a particular topic from the "colors" library:
help_colors("colorAray");
//output:
ECHO: "He
Hast du dieses Modell gedruckt? Einloggen und dein Make teilen!
Melde dich an, um einen Kommentar zu hinterlassen
AnmeldenNoch keine Kommentare – sei der Erste!