[fdo-commits] r2601 - in trunk/Providers/SHP: Docs/doc_src
Docs/doc_src/group_and_page_definitions Inc/SHP/Override
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 22 17:10:28 EST 2007
Author: gregboone
Date: 2007-02-22 17:10:28 -0500 (Thu, 22 Feb 2007)
New Revision: 2601
Modified:
trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP
trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h
trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassCollection.h
trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassDefinition.h
trunk/Providers/SHP/Inc/SHP/Override/FdoShpColumnDefinition.h
trunk/Providers/SHP/Inc/SHP/Override/FdoShpPhysicalSchemaMapping.h
trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinition.h
trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinitionCollection.h
Log:
Ticket #4: Update API documentation generation process
Modified: trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP 2007-02-22 22:10:28 UTC (rev 2601)
@@ -63,16 +63,17 @@
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
-WARNINGS = NO
-WARN_IF_UNDOCUMENTED = NO
-WARN_IF_DOC_ERROR = NO
-WARN_NO_PARAMDOC = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = warning_logfile.txt
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = group_and_page_definitions \
+ ../../Inc/SHP \
../../Inc/SHP/Override
FILE_PATTERNS = *.h
RECURSIVE = YES
@@ -107,7 +108,7 @@
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = ../HTML/SHP
-HTML_FILE_EXTENSION = .html
+HTML_FILE_EXTENSION = .htm
HTML_HEADER = headers_and_footers/header.html
HTML_FOOTER = headers_and_footers/footer.html
HTML_STYLESHEET = headers_and_footers/custom.css
Modified: trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -47,7 +47,4 @@
<br>
</div>
*/
-
-
-
-
+/// \defgroup typedefs
Modified: trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassCollection.h
===================================================================
--- trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassCollection.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassCollection.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -36,6 +36,10 @@
virtual void Dispose();
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoShpOvClassCollectionP is an FdoPtr on FdoShpOvClassCollection
+/// provided for convenience.
typedef FdoPtr<FdoShpOvClassCollection> FdoShpOvClassCollectionP;
#endif // FDOSHPCLASSCOLLECTION_H
Modified: trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassDefinition.h
===================================================================
--- trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassDefinition.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Inc/SHP/Override/FdoShpClassDefinition.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -57,6 +57,10 @@
FdoShpOvPropertyDefinitionCollectionP m_Properties;
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoShpOvClassDefinitionP is an FdoPtr on FdoShpOvClassDefinition
+/// provided for convenience.
typedef FdoPtr<FdoShpOvClassDefinition> FdoShpOvClassDefinitionP;
#endif // FDOSHPCLASSDEFINITION_H
Modified: trunk/Providers/SHP/Inc/SHP/Override/FdoShpColumnDefinition.h
===================================================================
--- trunk/Providers/SHP/Inc/SHP/Override/FdoShpColumnDefinition.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Inc/SHP/Override/FdoShpColumnDefinition.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -40,6 +40,10 @@
virtual void Dispose(void);
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoShpOvColumnDefinitionP is an FdoPtr on FdoShpOvColumnDefinition
+/// provided for convenience.
typedef FdoPtr<FdoShpOvColumnDefinition> FdoShpOvColumnDefinitionP;
#endif // FDOSHPCOLUMNDEFINITION_H
Modified: trunk/Providers/SHP/Inc/SHP/Override/FdoShpPhysicalSchemaMapping.h
===================================================================
--- trunk/Providers/SHP/Inc/SHP/Override/FdoShpPhysicalSchemaMapping.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Inc/SHP/Override/FdoShpPhysicalSchemaMapping.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -53,6 +53,10 @@
FdoShpOvClassCollectionP m_Classes;
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoShpOvPhysicalSchemaMappingP is an FdoPtr on FdoShpOvPhysicalSchemaMapping
+/// provided for convenience.
typedef FdoPtr<FdoShpOvPhysicalSchemaMapping> FdoShpOvPhysicalSchemaMappingP;
#endif // FDOSHPPHYSICALSCHEMAMAPPING_H
Modified: trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinition.h
===================================================================
--- trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinition.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinition.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -48,6 +48,10 @@
FdoShpOvColumnDefinitionP m_ColumnDefinition;
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoShpOvPropertyDefinition is an FdoPtr on FdoShpOvPropertyDefinition
+/// provided for convenience.
typedef FdoPtr<FdoShpOvPropertyDefinition> FdoShpOvPropertyDefinitionP;
#endif // FDOSHPPROPERTYDEFINITION_H
Modified: trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinitionCollection.h
===================================================================
--- trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinitionCollection.h 2007-02-22 22:09:03 UTC (rev 2600)
+++ trunk/Providers/SHP/Inc/SHP/Override/FdoShpPropertyDefinitionCollection.h 2007-02-22 22:10:28 UTC (rev 2601)
@@ -36,6 +36,10 @@
virtual void Dispose();
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoShpOvPropertyDefinitionCollectionP is an FdoPtr on FdoShpOvPropertyDefinitionCollection
+/// provided for convenience.
typedef FdoPtr<FdoShpOvPropertyDefinitionCollection> FdoShpOvPropertyDefinitionCollectionP;
More information about the fdo-commits
mailing list