diff --git a/Doxyfile b/Doxyfile index 85a4e9e..a8d219f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = +PROJECT_NAME = ObjIdLib # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -37,7 +37,7 @@ PROJECT_NUMBER = # 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 = "A library for working with NTFS Object Idenitifers" # 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 @@ -51,7 +51,7 @@ PROJECT_LOGO = # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = . # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output @@ -128,7 +128,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -193,7 +193,7 @@ SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. -TAB_SIZE = 8 +TAB_SIZE = 2 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". @@ -209,7 +209,7 @@ ALIASES = # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. -OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for @@ -619,7 +619,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT = . # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -702,7 +702,8 @@ EXCLUDE_PATTERNS = # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = POBJECTID_ATTRIBUTE \ + OBJIDLIB_API # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see @@ -879,7 +880,7 @@ HTML_HEADER = # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = ../../doxy_footer.htm # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to @@ -1197,7 +1198,7 @@ SERVER_BASED_SEARCH = NO # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be diff --git a/objidlib.cpp b/objidlib.cpp index dfe9910..97dc325 100644 --- a/objidlib.cpp +++ b/objidlib.cpp @@ -1,3 +1,10 @@ +/** @file objidlib.cpp + * @brief A library for working with NTFS Object Idenitifers + * @author amdf + * @version 0.1 + * @date May 2011 + */ + #include "stdafx.h" #include "objidlib.h" diff --git a/objidlib.h b/objidlib.h index 1ace174..ca4516e 100644 --- a/objidlib.h +++ b/objidlib.h @@ -1,5 +1,6 @@ /** @file objidlib.h - * @brief A library for working with NTFS Object Idenitifers + * @brief A header file of a library for + * working with NTFS Object Idenitifers * @author amdf * @version 0.1 * @date May 2011 diff --git a/objidlib.vcxproj b/objidlib.vcxproj index b27897b..139c68a 100644 --- a/objidlib.vcxproj +++ b/objidlib.vcxproj @@ -148,9 +148,6 @@ ntdll.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies) - - - diff --git a/stdafx.h b/stdafx.h index 4aac831..9c06d87 100644 --- a/stdafx.h +++ b/stdafx.h @@ -1,11 +1,15 @@ /*! \mainpage ObjIdLib * - * A library for working with NTFS Object Idenitifers + * ObjIdLib is a Windows dynamic link library for working with NTFS Object Idenitifers. * - * \section usage_sec Using + * \section bin_sec Binary * - * ObjIdLib is a dynamic link library for Windows applications. - * File name is objidlib.dll. + * You can download ObjIdLib at http://hex.pp.ua/files/objidlib-0.1.rar + * The package contains 32-bit and 64-bit files objidlib.dll and objidlib.lib, + * a source code and a copy of this html help. + * + * \section src_sec Source + * Latest source code is available at http://github.com/amdf/objidlib */ #pragma once