History

Daniel Verkamp 025f20fbdd doc: tweak some Doxygen configuration parameters

- Show undocumented members so that they at least show up in the
output, even if they don't have any associated doc string.  Everything
in the public headers should be public API.

- Disable include graph generation.  This is fairly useless for our
purposes, since only public API headers are included in the Doxygen
input list, and we don't need to see how they include each other.

Change-Id: Ie1e2d5a93c1ae526d5867e0707faf40e32d1c969
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>

2016-12-19 15:58:00 -07:00

ioat

doc: organize Key Functions into tables

2016-08-15 16:07:26 -07:00

iscsi

bdev: remove unused field in data struct nvme_bdf_whitelist

2016-10-14 01:55:16 +08:00

nvme

doc: update link to renamed deallocate function

2016-12-08 10:01:08 -07:00

nvmf

doc: replace another "NVMf" with NVMe over Fabrics

2016-08-15 16:07:26 -07:00

directory_structure.txt

doc: Begin documenting the directory structure

2016-12-07 16:03:16 -07:00

Doxyfile

doc: tweak some Doxygen configuration parameters

2016-12-19 15:58:00 -07:00

footer.html

Change doc link to new spdk.io/doc location

2016-12-19 15:57:12 -07:00

header.html

docs: Update header and footer links in documentation

2016-07-01 14:51:35 -07:00

mainpage.txt

doc: Begin documenting the directory structure

2016-12-07 16:03:16 -07:00

Makefile

doc: merge ioat and nvme into a single Doxyfile

2016-03-25 09:59:39 -07:00

README.md

Change doc link to new spdk.io/doc location

2016-12-19 15:57:12 -07:00

stylesheet.css

eofnl: check for extra trailing newlines

2016-10-11 13:30:33 -07:00

README.md

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.