OpenSCAD Module_Help

thingiverse

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 <./path/to/library>` 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 <./libraries/colors.scad> 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: "Help for module/function: colorArray" ECHO: "function: colorAray(columns = <integer>, rows = <integer, scaled = <boolean>)" ECHO: "returns: <vector of vectors>" ECHO: "Description: returns column X rows vector of interpolated RGB values" ECHO: "Paramaters:" ECHO: " columns <integer> 1-255 columns" ECHO: " rows <integer> 1-255 rows" ECHO: " scaled <boolean> scale the colors from white to full color" The model library included below requires a library name and a vector containing specific help information. See the examples below: //Examples LibraryName = "Name of your library"; modules = [ ["nameOfModuleOrFunction", "module: nameOfModuleOrFunction(param1 = <data type>)", "returns: none (module)", "Description: This module does things", "Paramaters: ", " radius <real> radius of bolt head", " number <integer> number of objects to draw" ], ];