[PATCH 5/6] autodoc: add doc from ptrlist.c

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Use the doc added to ptrlist.c as an example/base for
API documentation.

Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx>
---
 Documentation/api.rst   | 11 +++++++++++
 Documentation/index.rst |  1 +
 2 files changed, 12 insertions(+)
 create mode 100644 Documentation/api.rst

diff --git a/Documentation/api.rst b/Documentation/api.rst
new file mode 100644
index 000000000..8b6f04011
--- /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 df6ca3d8a..25412bb83 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -22,6 +22,7 @@ Developer documentation
    test-suite
    dev-options
    IR
+   api
 
 How to contribute
 -----------------
-- 
2.17.0

--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Newbies FAQ]     [LKML]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Trinity Fuzzer Tool]

  Powered by Linux