@vandenberghinc/libris v1.1.5

Integrate Libris

To document your code using Libris, simply place a structured comment block above the code you want to document. Libris will automatically parse important information such as the function name, return type, function keywords, parameters, templates, requires clause and more. The @docs tag is universal and can be used with all supported languages.

/*  @docs:
 *  @title: Load
 *  @description: Load a file.
 *  @parameter:
 *      @name: path
 *      @description: The path of the file.
 *  @usage:
 *      char* data = load("./myfile.txt");
 */
char*  load(const char* path) { ... }

More information can be found in the Documentation.

Obtain your API Key.

The Libris Client requires an API Key.