Updated Doxygen docs to use GitHub repo README as main page. Added a seagate... (bef8bd42) · Commits · kinetic-archive / kinetic-c

README.md

+9 −5

Original line number	Diff line number	Diff line
		<div style="float: right"><a href="https://travis-ci.org/atomicobject/kinetic-c"><img src="https://travis-ci.org/atomicobject/kinetic-c.png?branch=master" /></a></div>
		Introduction
		============
		Kinetic-C Client Library
		========================
		![](http://travis-ci.org/atomicobject/kinetic-c.png?branch=master)

		This repo contains code for producing C Kinetic clients which use the Seagate Kinetic protocol. Code examples/utilities that use the Kinetic C library are included for reference and usage during development.

		[Kinetic-C build status](http://travis-ci.org/atomicobject/kinetic-c) is provided via [Travis CI](http://travis-ci.org)

		Getting Started
		================

		> git clone --recursive https://github.com/atomicobject/kinetic-c.git

		> cd kinetic-c
		> bundle install # Ensures you have all RubyGems needed
		> bundle execute rake #run all tests and build kinetic-c library and examples
		> bundle execute rake # Run all tests and build kinetic-c library and examples

		API Docuemntation
		API Documentation
		=================
		[Kinetic-C API](http://atomicobject.github.io/kinetic-c/) (generated with Doxygen)

Rakefile

+2 −1

Original line number	Diff line number	Diff line
		@@ -91,7 +91,8 @@ namespace :doxygen do
		task :gen => [DOCS_PATH] do
		# Update API version in doxygen config
		doxyfile = "config/Doxyfile"
		content = File.read(doxyfile).sub(/^PROJECT_NUMBER +=.*$/, "PROJECT_NUMBER = \"v#{VERSION}\"")
		content = File.read(doxyfile)
		content.sub!(/^PROJECT_NUMBER +=.*$/, "PROJECT_NUMBER = \"v#{VERSION}\"")
		File.open(doxyfile, 'w').puts content

		# Generate the Doxygen API docs

VERSION

+1 −1

Original line number	Diff line number	Diff line
		0.3.0-beta
		0.3.1-beta

config/Doxyfile

+33 −31

Original line number	Diff line number	Diff line
		@@ -38,20 +38,20 @@ PROJECT_NAME = "protobuf-c"
		# could be handy for archiving the generated documentation or if some version
		# control system is used.

		PROJECT_NUMBER = "v0.3.0-beta"
		PROJECT_NUMBER = "v0.3.1-beta"

		# Using the PROJECT_BRIEF tag one can provide an optional one line description
		# for a project that appears at the top of each page and should give viewer a
		# quick idea about the purpose of the project. Keep the description short.

		PROJECT_BRIEF = "Protocol Buffers implementation in C"
		PROJECT_BRIEF = "Seagate Kinetic Protocol Client Library for C"

		# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
		# the documentation. The maximum height of the logo should not exceed 55 pixels
		# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
		# to the output directory.

		PROJECT_LOGO =
		PROJECT_LOGO = ./config/seagate-logo-w-title-sm.png

		# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
		# into which the generated documentation will be written. If a relative path is
		@@ -76,7 +76,8 @@ CREATE_SUBDIRS = NO
		# U+3044.
		# The default value is: NO.

		ALLOW_UNICODE_NAMES = NO
		# Unsupported by Doxygen 1.8.6
		# ALLOW_UNICODE_NAMES = NO

		# The OUTPUT_LANGUAGE tag is used to specify the language in which all
		# documentation generated by doxygen is written. Doxygen will use this
		@@ -216,7 +217,7 @@ SEPARATE_MEMBER_PAGES = NO
		# uses this value to replace tabs by spaces in code fragments.
		# Minimum value: 1, maximum value: 16, default value: 4.

		TAB_SIZE = 8
		TAB_SIZE = 4

		# This tag can be used to specify a number of aliases that act as commands in
		# the documentation. An alias has the form:
		@@ -415,13 +416,13 @@ EXTRACT_ALL = NO
		# be included in the documentation.
		# The default value is: NO.

		EXTRACT_PRIVATE = NO
		EXTRACT_PRIVATE = YES

		# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
		# scope will be included in the documentation.
		# The default value is: NO.

		EXTRACT_PACKAGE = NO
		EXTRACT_PACKAGE = YES

		# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
		# included in the documentation.
		@@ -498,7 +499,7 @@ INTERNAL_DOCS = NO
		# and Mac users are advised to set this option to NO.
		# The default value is: system dependent.

		CASE_SENSE_NAMES = YES
		CASE_SENSE_NAMES = NO

		# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
		# their full class and namespace scopes in the documentation. If set to YES the
		@@ -511,14 +512,14 @@ HIDE_SCOPE_NAMES = NO
		# the files that are included by a file in the documentation of that file.
		# The default value is: YES.

		SHOW_INCLUDE_FILES = NO
		SHOW_INCLUDE_FILES = YES

		# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
		# grouped member an include statement to the documentation, telling the reader
		# which file to include in order to use the member.
		# The default value is: NO.

		SHOW_GROUPED_MEMB_INC = NO
		SHOW_GROUPED_MEMB_INC = YES

		# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
		# files with double quotes in the documentation rather than with sharp brackets.
		@@ -635,21 +636,21 @@ MAX_INITIALIZER_LINES = 30
		# will mention the files that were used to generate the documentation.
		# The default value is: YES.

		SHOW_USED_FILES = NO
		SHOW_USED_FILES = YES

		# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
		# will remove the Files entry from the Quick Index and from the Folder Tree View
		# (if specified).
		# The default value is: YES.

		SHOW_FILES = NO
		SHOW_FILES = YES

		# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
		# page. This will remove the Namespaces entry from the Quick Index and from the
		# Folder Tree View (if specified).
		# The default value is: YES.

		SHOW_NAMESPACES = NO
		SHOW_NAMESPACES = YES

		# The FILE_VERSION_FILTER tag can be used to specify a program or script that
		# doxygen should invoke to get the current version for each file (typically from
		@@ -672,7 +673,7 @@ FILE_VERSION_FILTER =
		# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
		# tag is left empty.

		LAYOUT_FILE = ./DoxygenLayout.xml
		LAYOUT_FILE = ./config/DoxygenLayout.xml

		# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
		# the reference definitions. This must be a list of .bib files. The .bib
		@@ -754,7 +755,7 @@ WARN_LOGFILE =
		# spaces.
		# Note: If this tag is empty the current directory is searched.

		INPUT = ./protobuf-c
		INPUT = ./include ./src

		# This tag can be used to specify the character encoding of the source files
		# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
		@@ -890,7 +891,7 @@ FILTER_SOURCE_PATTERNS =
		# (index.html). This can be useful if you have a project on for instance GitHub
		# and want to reuse the introduction page also for the doxygen output.

		USE_MDFILE_AS_MAINPAGE =
		USE_MDFILE_AS_MAINPAGE = ./README.md

		#---------------------------------------------------------------------------
		# Configuration options related to source browsing
		@@ -928,7 +929,7 @@ REFERENCED_BY_RELATION = NO
		# all documented entities called/used by that function will be listed.
		# The default value is: NO.

		REFERENCES_RELATION = NO
		REFERENCES_RELATION = YES

		# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
		# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
		@@ -1019,7 +1020,7 @@ GENERATE_HTML = YES
		# The default directory is: html.
		# This tag requires that the tag GENERATE_HTML is set to YES.

		HTML_OUTPUT = html
		HTML_OUTPUT = .

		# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
		# generated HTML page (for example: .htm, .php, .asp).
		@@ -1162,7 +1163,7 @@ HTML_INDEX_NUM_ENTRIES = 100
		# The default value is: NO.
		# This tag requires that the tag GENERATE_HTML is set to YES.

		GENERATE_DOCSET = NO
		GENERATE_DOCSET = YES

		# This tag determines the name of the docset feed. A documentation feed provides
		# an umbrella under which multiple documentation sets from a single provider
		@@ -1170,7 +1171,7 @@ GENERATE_DOCSET = NO
		# The default value is: Doxygen generated docs.
		# This tag requires that the tag GENERATE_DOCSET is set to YES.

		DOCSET_FEEDNAME = "Doxygen generated docs"
		DOCSET_FEEDNAME = "Seagate Kinetic Docs"

		# This tag specifies a string that should uniquely identify the documentation
		# set bundle. This should be a reverse domain-name style string, e.g.
		@@ -1178,7 +1179,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
		# The default value is: org.doxygen.Project.
		# This tag requires that the tag GENERATE_DOCSET is set to YES.

		DOCSET_BUNDLE_ID = org.doxygen.Project
		DOCSET_BUNDLE_ID = com.seagate.kinetic-c

		# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
		# the documentation publisher. This should be a reverse domain-name style
		@@ -1186,13 +1187,13 @@ DOCSET_BUNDLE_ID = org.doxygen.Project
		# The default value is: org.doxygen.Publisher.
		# This tag requires that the tag GENERATE_DOCSET is set to YES.

		DOCSET_PUBLISHER_ID = org.doxygen.Publisher
		DOCSET_PUBLISHER_ID = com.seagate

		# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
		# The default value is: Publisher.
		# This tag requires that the tag GENERATE_DOCSET is set to YES.

		DOCSET_PUBLISHER_NAME = Publisher
		DOCSET_PUBLISHER_NAME = Seagate

		# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
		# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
		@@ -1217,7 +1218,7 @@ GENERATE_HTMLHELP = NO
		# written to the html output directory.
		# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

		CHM_FILE =
		CHM_FILE = seagate-kinetic-c.chm

		# The HHC_LOCATION tag can be used to specify the location (absolute path
		# including file name) of the HTML help compiler ( hhc.exe). If non-empty
		@@ -1262,14 +1263,14 @@ TOC_EXPAND = NO
		# The default value is: NO.
		# This tag requires that the tag GENERATE_HTML is set to YES.

		GENERATE_QHP = NO
		GENERATE_QHP = YES

		# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
		# the file name of the resulting .qch file. The path specified is relative to
		# the HTML output folder.
		# This tag requires that the tag GENERATE_QHP is set to YES.

		QCH_FILE =
		QCH_FILE = seagate-kinetic-c.qch

		# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
		# Project output. For more information please see Qt Help Project / Namespace
		@@ -1328,7 +1329,7 @@ QHG_LOCATION =
		# The default value is: NO.
		# This tag requires that the tag GENERATE_HTML is set to YES.

		GENERATE_ECLIPSEHELP = NO
		GENERATE_ECLIPSEHELP = YES

		# A unique identifier for the Eclipse help plugin. When installing the plugin
		# the directory name containing the HTML and XML files should also have this
		@@ -1336,7 +1337,7 @@ GENERATE_ECLIPSEHELP = NO
		# The default value is: org.doxygen.Project.
		# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.

		ECLIPSE_DOC_ID = org.doxygen.Project
		ECLIPSE_DOC_ID = com.seagate.kinetic-c

		# If you want full control over the layout of the generated HTML pages it might
		# be necessary to disable the index and replace it with your own. The
		@@ -1595,7 +1596,7 @@ COMPACT_LATEX = NO
		# The default value is: a4.
		# This tag requires that the tag GENERATE_LATEX is set to YES.

		PAPER_TYPE = a4
		PAPER_TYPE = letter

		# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
		# that should be included in the LaTeX output. To get the times font for
		@@ -1754,7 +1755,7 @@ RTF_EXTENSIONS_FILE =
		# classes and files.
		# The default value is: NO.

		GENERATE_MAN = NO
		GENERATE_MAN = YES

		# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
		# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
		@@ -1779,7 +1780,8 @@ MAN_EXTENSION = .3
		# MAN_EXTENSION with the initial . removed.
		# This tag requires that the tag GENERATE_MAN is set to YES.

		MAN_SUBDIR =
		# Unsupported by Doxygen 1.8.6
		# MAN_SUBDIR =

		# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
		# will generate one additional man file for each entity documented in the real

config/DoxygenLayout.xml

0 → 100644

+193 −0

Original line number	Diff line number	Diff line
		<doxygenlayout version="1.0">
		<!-- Generated by doxygen 1.8.7 -->
		<!-- Navigation index tabs for HTML output -->
		<navindex>
		<tab type="mainpage" visible="yes" title=""/>
		<tab type="pages" visible="yes" title="" intro=""/>
		<tab type="modules" visible="yes" title="" intro=""/>
		<tab type="namespaces" visible="yes" title="">
		<tab type="namespacelist" visible="yes" title="" intro=""/>
		<tab type="namespacemembers" visible="yes" title="" intro=""/>
		</tab>
		<tab type="classes" visible="yes" title="">
		<tab type="classlist" visible="yes" title="" intro=""/>
		<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
		<tab type="hierarchy" visible="yes" title="" intro=""/>
		<tab type="classmembers" visible="yes" title="" intro=""/>
		</tab>
		<tab type="files" visible="yes" title="">
		<tab type="filelist" visible="yes" title="" intro=""/>
		<tab type="globals" visible="yes" title="" intro=""/>
		</tab>
		<tab type="examples" visible="yes" title="" intro=""/>
		</navindex>

		<!-- Layout definition for a class page -->
		<class>
		<briefdescription visible="yes"/>
		<includes visible="$SHOW_INCLUDE_FILES"/>
		<inheritancegraph visible="$CLASS_GRAPH"/>
		<collaborationgraph visible="$COLLABORATION_GRAPH"/>
		<memberdecl>
		<nestedclasses visible="yes" title=""/>
		<publictypes title=""/>
		<services title=""/>
		<interfaces title=""/>
		<publicslots title=""/>
		<signals title=""/>
		<publicmethods title=""/>
		<publicstaticmethods title=""/>
		<publicattributes title=""/>
		<publicstaticattributes title=""/>
		<protectedtypes title=""/>
		<protectedslots title=""/>
		<protectedmethods title=""/>
		<protectedstaticmethods title=""/>
		<protectedattributes title=""/>
		<protectedstaticattributes title=""/>
		<packagetypes title=""/>
		<packagemethods title=""/>
		<packagestaticmethods title=""/>
		<packageattributes title=""/>
		<packagestaticattributes title=""/>
		<properties title=""/>
		<events title=""/>
		<privatetypes title=""/>
		<privateslots title=""/>
		<privatemethods title=""/>
		<privatestaticmethods title=""/>
		<privateattributes title=""/>
		<privatestaticattributes title=""/>
		<friends title=""/>
		<related title="" subtitle=""/>
		<membergroups visible="yes"/>
		</memberdecl>
		<detaileddescription title=""/>
		<memberdef>
		<inlineclasses title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<services title=""/>
		<interfaces title=""/>
		<constructors title=""/>
		<functions title=""/>
		<related title=""/>
		<variables title=""/>
		<properties title=""/>
		<events title=""/>
		</memberdef>
		<allmemberslink visible="yes"/>
		<usedfiles visible="$SHOW_USED_FILES"/>
		<authorsection visible="yes"/>
		</class>

		<!-- Layout definition for a namespace page -->
		<namespace>
		<briefdescription visible="yes"/>
		<memberdecl>
		<nestednamespaces visible="yes" title=""/>
		<constantgroups visible="yes" title=""/>
		<classes visible="yes" title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<functions title=""/>
		<variables title=""/>
		<membergroups visible="yes"/>
		</memberdecl>
		<detaileddescription title=""/>
		<memberdef>
		<inlineclasses title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<functions title=""/>
		<variables title=""/>
		</memberdef>
		<authorsection visible="yes"/>
		</namespace>

		<!-- Layout definition for a file page -->
		<file>
		<briefdescription visible="yes"/>
		<includes visible="$SHOW_INCLUDE_FILES"/>
		<includegraph visible="$INCLUDE_GRAPH"/>
		<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
		<sourcelink visible="yes"/>
		<memberdecl>
		<classes visible="yes" title=""/>
		<namespaces visible="yes" title=""/>
		<constantgroups visible="yes" title=""/>
		<defines title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<functions title=""/>
		<variables title=""/>
		<membergroups visible="yes"/>
		</memberdecl>
		<detaileddescription title=""/>
		<memberdef>
		<inlineclasses title=""/>
		<defines title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<functions title=""/>
		<variables title=""/>
		</memberdef>
		<authorsection/>
		</file>

		<!-- Layout definition for a group page -->
		<group>
		<detaileddescription title=""/>
		<groupgraph visible="$GROUP_GRAPHS"/>
		<memberdecl>
		<nestedgroups visible="yes" title=""/>
		<dirs visible="yes" title=""/>
		<files visible="yes" title=""/>
		<namespaces visible="yes" title=""/>
		<classes visible="yes" title=""/>
		<defines title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<enumvalues title=""/>
		<functions title=""/>
		<variables title=""/>
		<signals title=""/>
		<publicslots title=""/>
		<protectedslots title=""/>
		<privateslots title=""/>
		<events title=""/>
		<properties title=""/>
		<friends title=""/>
		<membergroups visible="yes"/>
		</memberdecl>
		<memberdef>
		<pagedocs/>
		<inlineclasses title=""/>
		<defines title=""/>
		<typedefs title=""/>
		<enums title=""/>
		<enumvalues title=""/>
		<functions title=""/>
		<variables title=""/>
		<signals title=""/>
		<publicslots title=""/>
		<protectedslots title=""/>
		<privateslots title=""/>
		<events title=""/>
		<properties title=""/>
		<friends title=""/>
		</memberdef>
		<authorsection visible="yes"/>
		</group>

		<!-- Layout definition for a directory page -->
		<directory>
		<briefdescription visible="yes"/>
		<directorygraph visible="yes"/>
		<memberdecl>
		<dirs visible="yes"/>
		<files visible="yes"/>
		</memberdecl>
		<detaileddescription title=""/>
		</directory>
		</doxygenlayout>