diff options
| author | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2018-05-12 14:25:44 +0200 |
|---|---|---|
| committer | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2018-05-21 02:49:44 +0200 |
| commit | ab8f48ff06c8bc48a94d34db991a4a54f6a2d40f (patch) | |
| tree | d90fba04c7b24d12ada632869e1701e2a2c77324 | |
| parent | f647b26c75beb08bb51d308f9922776d4de091e9 (diff) | |
| download | sparse-dev-ab8f48ff06c8bc48a94d34db991a4a54f6a2d40f.tar.gz | |
autodoc: add doc from ptrlist.c
Use the doc added to ptrlist.c as an example/base for
API documentation.
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
| -rw-r--r-- | Documentation/api.rst | 11 | ||||
| -rw-r--r-- | Documentation/index.rst | 1 |
2 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/api.rst b/Documentation/api.rst new file mode 100644 index 00000000..8b6f0401 --- /dev/null +++ b/Documentation/api.rst @@ -0,0 +1,11 @@ +Sparse API +========== + +.. contents:: + :local: + :depth: 2 + +Utilities +~~~~~~~~~ + +.. c:autodoc:: ptrlist.c diff --git a/Documentation/index.rst b/Documentation/index.rst index 637c4435..919cf482 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -21,6 +21,7 @@ Developer documentation test-suite dev-options IR + api How to contribute ----------------- |