NTDOC - A Documentation Generator


 

Abstract

NTDOC generates documentation for a Common Lisp package via introspection, extracting metadata from the corresponding ASDF system. It is based on DOCUMENTATION-TEMPLATE by Edi Weitz.

NTDOC is available under the 3-Clause BSD license.

Download Source: git clone https://github.com/ndantam/cl-ntdoc


 

Contents

  1. The NTDOC dictionary
    1. *maybe-skip-methods-p*
    2. *target*
    3. create-template
  2. Authors
  3. Acknowledgements

 

The NTDOC dictionary


[Special variable]
*maybe-skip-methods-p*


This is the default value for the :MAYBE-SKIP-METHODS-P keyword argument of CREATE-TEMPLATE and its initial value is NIL. It is also used internally.


[Special variable]
*target*


Where to output the HTML page. If this value is not NIL, it will be the default target for CREATE-TEMPLATE. CREATE-TEMPLATE will also set this value.


[Function]
create-template package &key target system author-homepage subtitle license author repository description (maybe-skip-methods-p *maybe-skip-methods-p*) if-exists if-does-not-exist => result


Writes an HTML page with preliminary documentation entries and an index for all exported symbols of the package PACKAGE to the file TARGET. If MAYBE-SKIP-METHODS-P is true, documentation entries for inidividual methods are skipped if the corresponding generic function has a documentation string.

Authors


 

Acknowledgements

This documentation was prepared with DOCUMENTATION-TEMPLATE.

BACK TO MY HOMEPAGE