Merge pull request #43 from fstamour/master

fix documentation generate-clml-api-docs -> generate-api-docs
mmaul · Dec 7, 2020 · c1c2fa9 · c1c2fa9
2 parents 95505b5 + c4ea1e2
commit c1c2fa9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -341,9 +341,9 @@ most easily in the [clod](http://quickdocs.org/clod/api) api documentation] at [
 
     (ql:quickload :clml.docs :verbose t)
     (in-package :clml.docs)
-    (generate-clml-api-docs)
+    (generate-api-docs)
 
-The generate-clml-api-docs form enerates Org API documentation in the **clml/docs/api** directory from loaded packages for
+The generate-api-docs form enerates Org API documentation in the **clml/docs/api** directory from loaded packages for
 CLML for packages matching the following prefix patterns:
 
     +^clml[.]

diff --git a/docs/USING.org b/docs/USING.org
@@ -214,10 +214,10 @@ Here is a quick demonstration:
 #+BEGIN_SRC lisp
 (ql:quickload :clml.docs :verbose t)
 (in-package :clml.docs)
-(generate-clml-api-docs)
+(generate-api-docs)
 #+END_SRC
 
-The generate-clml-api-docs form enerates Org API documentation in the *clml/docs/api* directory from loaded packages for
+The generate-api-docs form enerates Org API documentation in the *clml/docs/api* directory from loaded packages for
 CLML for packages matching the following prefix patterns:
 #+BEGIN_SRC lisp
   +^clml[.]
@@ -230,7 +230,7 @@ CLML for packages matching the following prefix patterns:
   Documentation is in the form of Org files where one Org file per package is placed in
   *clml/docs/api*.  A package index file containing Org INCLUDE
   directives that include 
-  Org files generated by the form *generate-clml-api-docs* are  placed
+  Org files generated by the form *generate-api-docs* are  placed
   in *clml/docs/api/index.org*.
 
   The CLML users manual includes the generated API documentation file index.org,

diff --git a/docs/clml-manual.html b/docs/clml-manual.html
@@ -7347,14 +7347,14 @@ <h4 id="sec-22-2-1"><span class="section-number-4">22.2.1</span> External Functi
 
 
 <div id="outline-container-sec-22-2-1-1" class="outline-5">
-<h5 id="sec-22-2-1-1"><span class="section-number-5">22.2.1.1</span> Function: <code>generate-clml-api-docs</code></h5>
+<h5 id="sec-22-2-1-1"><span class="section-number-5">22.2.1.1</span> Function: <code>generate-api-docs</code></h5>
 <div class="outline-text-5" id="text-22-2-1-1">
 </div><div id="outline-container-sec-22-2-1-1-1" class="outline-6">
 <h6 id="sec-22-2-1-1-1"><span class="section-number-6">22.2.1.1.1</span> Syntax</h6>
 <div class="outline-text-6" id="text-22-2-1-1-1">
 <div class="org-src-container">
 
-<pre class="src src-lisp"><span style="color: #7f7f7f;">(</span>generate-clml-api-docs<span style="color: #7f7f7f;">)</span>
+<pre class="src src-lisp"><span style="color: #7f7f7f;">(</span>generate-api-docs<span style="color: #7f7f7f;">)</span>
 </pre>
 </div>
 </div>