Merge pull request #31 from paddatrapper/docs

Add extra properties to doc generation

Makefile

@@ -9,6 +9,8 @@ $(FX2LIBDIR)/.git: .gitmodules
 
 # FIXME: Add check_int2jit from hdmi2usb/Makefile
 
+docs: export PROJECT_NUMBER:=$(shell git describe --always --dirty --long)
+
 .PHONY: docs clean
 
 docs:

docs/docs.conf

@@ -38,20 +38,20 @@ PROJECT_NAME           = "HDMI2USB"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = $(PROJECT_NUMBER)
 
 # 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          =
+PROJECT_BRIEF          = "Record and stream HD videos for conferences and meetings"
 
 # With the PROJECT_LOGO tag one can specify a logo or an 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           = docs/logo.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
@@ -790,7 +790,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = README.md hdmi2usb examples/lights examples/seria
+INPUT                  = README.md hdmi2usb examples/lights examples/serial
 
 # 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