Commit 8eafb654 authored Apr 29, 2016 by Daniel Verkamp

doc: add Doxygen file marker to all public headers



For existing \file markers, move them to the top of the header and tweak
the wording for consistency.

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

parent d0cbec4a

include/spdk/assert.h

+4 −0

Original line number	Diff line number	Diff line
		@@ -31,6 +31,10 @@
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/** \file
		* Runtime and compile-time assert macros
		*/

		#ifndef SPDK_ASSERT_H
		#define SPDK_ASSERT_H

include/spdk/barrier.h

+4 −0

Original line number	Diff line number	Diff line
		@@ -31,6 +31,10 @@
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/** \file
		* Memory barriers
		*/

		#ifndef SPDK_BARRIER_H
		#define SPDK_BARRIER_H

include/spdk/file.h

+4 −0

Original line number	Diff line number	Diff line
		@@ -31,6 +31,10 @@
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/** \file
		* OS filesystem utility functions
		*/

		#ifndef SPDK_FILE_H
		#define SPDK_FILE_H

include/spdk/ioat.h

+1 −1

Original line number	Diff line number	Diff line
		@@ -32,7 +32,7 @@
		*/

		/** \file
		* This file defines the public interface to the I/OAT DMA engine driver.
		* I/OAT DMA engine driver public interface
		*/

		#ifndef SPDK_IOAT_H

include/spdk/ioat_spec.h

+5 −0

Original line number	Diff line number	Diff line
		@@ -31,6 +31,11 @@
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/**
		* \file
		* I/OAT specification definitions
		*/

		#ifndef SPDK_IOAT_SPEC_H
		#define SPDK_IOAT_SPEC_H