Skip to content

Commit

Permalink
working on documentaiton.
Browse files Browse the repository at this point in the history
removing html documentation… i will only commit the pdf version.

git-svn-id: https://svn.csail.mit.edu/locomotion/robotlib/trunk@7258 c9849af7-e679-4ec6-a44e-fc146a885bd3
  • Loading branch information
russt committed Sep 17, 2013
1 parent 125ba0d commit b506b9d
Show file tree
Hide file tree
Showing 6 changed files with 177 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,4 @@ lcmtypes/python
build
unitTest.log
mlint_output.html
doc/DoxygenMatlab/latex
13 changes: 12 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,23 @@ configure:
@cd pod-build && cmake -DCMAKE_INSTALL_PREFIX=$(BUILD_PREFIX) \
-DCMAKE_BUILD_TYPE=$(BUILD_TYPE) ..

.PHONY: doc

.PHONY: doc pdfdoc htmldoc
doc: doxygen

doxygen :
doxygen doc/Doxyfile

pdfdoc:
# todo: fix then enable doxygen pdf output
cd doc && /Applications/oxygen/schemaDocumentationMac.sh DrakeURDF.xsd -cfg:oxygen_export_settings_pdf.xml
cd doc && maketex drake.pdf

htmldoc: doxygen
# apologies for hard-coding this for my mac for now... - Russ
cd doc && /Applications/oxygen/schemaDocumentationMac.sh DrakeURDF.xsd -cfg:oxygen_export_settings_html.xml
# cd doc && maketex html # need to fix this

.PHONY: mlint
mlint :
matlab -nodisplay -r "addpath(fullfile(pwd,'thirdParty','runmlint')); runmlint('.mlintopts'); exit"
Expand Down
19 changes: 19 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Maintainers: Russ Tedrake <[email protected]>
Summary: A planning, control, and analysis toolbox for nonlinear dynamical systems
Description: http://drake.mit.edu


Requirements:
spotless

Expand All @@ -22,5 +23,23 @@ Optional Dependencies:
sedumi
cplex


MATLAB Toolbox Dependencies:
Spline Toolbox
Image Processing Toolbox (should be able to remove this one)
% todo: finish this list

Prerequisites for MacPorts:
port install wget gsed graphviz
% todo: finish this list

Prerequisites for Homebrew:
brew install wget gnu-sed graphviz
% todo: finish this list

Prerequisites for Ubuntu:
apt-get install
% todo: finish this list

License: BSD (http://drake.mit.edu/license)

12 changes: 5 additions & 7 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -524,19 +524,19 @@ LAYOUT_FILE =
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET = NO
QUIET = YES

# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.

WARNINGS = YES
WARNINGS = NO

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.

WARN_IF_UNDOCUMENTED = YES
WARN_IF_UNDOCUMENTED = NO

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
Expand Down Expand Up @@ -636,9 +636,7 @@ RECURSIVE = YES
# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE = thirdParty \
externals \
examples \
drivers
examples

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
Expand Down Expand Up @@ -1047,7 +1045,7 @@ COMPACT_LATEX = NO
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.

PAPER_TYPE = a4wide
PAPER_TYPE = letter

# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
<Boolean>true</Boolean>
</field>
<field name="unexpandedOutputFile">
<String>${cfn}.html</String>
<String>urdf/${cfn}.html</String>
</field>
<field name="splitMethod">
<Integer>3</Integer>
Expand Down
139 changes: 139 additions & 0 deletions doc/oxygen_export_settings_pdf.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<?xml version="1.0" encoding="UTF-8"?>
<serialized version="15.0" xml:space="preserve">
<map>
<entry>
<String>xsd.documentation.options</String>
<xsdDocumentationOptions>
<field name="imageType">
<String>jpeg</String>
</field>
<field name="includeGlobalElements">
<Boolean>true</Boolean>
</field>
<field name="includeGlobalAttributes">
<Boolean>true</Boolean>
</field>
<field name="includeLocalElements">
<Boolean>true</Boolean>
</field>
<field name="includeLocalAttributes">
<Boolean>true</Boolean>
</field>
<field name="includeSimpleTypes">
<Boolean>true</Boolean>
</field>
<field name="includeComplexTypes">
<Boolean>true</Boolean>
</field>
<field name="includeGroups">
<Boolean>true</Boolean>
</field>
<field name="includeAttributesGroups">
<Boolean>true</Boolean>
</field>
<field name="includeRedefines">
<Boolean>true</Boolean>
</field>
<field name="includeReferencedSchemas">
<Boolean>true</Boolean>
</field>
<field name="includeNotations">
<Boolean>true</Boolean>
</field>
<field name="detailsDiagram">
<Boolean>true</Boolean>
</field>
<field name="detailsNamespace">
<Boolean>false</Boolean>
</field>
<field name="detailsLocation">
<Boolean>false</Boolean>
</field>
<field name="detailsType">
<Boolean>false</Boolean>
</field>
<field name="detailsTypeHierarchy">
<Boolean>false</Boolean>
</field>
<field name="detailsModel">
<Boolean>false</Boolean>
</field>
<field name="detailsChildren">
<Boolean>true</Boolean>
</field>
<field name="detailsInstance">
<Boolean>false</Boolean>
</field>
<field name="detailsUsedby">
<Boolean>false</Boolean>
</field>
<field name="detailsProperties">
<Boolean>false</Boolean>
</field>
<field name="detailsFacets">
<Boolean>false</Boolean>
</field>
<field name="detailsAttributes">
<Boolean>true</Boolean>
</field>
<field name="detailsAsserts">
<Boolean>false</Boolean>
</field>
<field name="detailsIdentityConstr">
<Boolean>false</Boolean>
</field>
<field name="detailsEscapeAnn">
<Boolean>true</Boolean>
</field>
<field name="detailsSource">
<Boolean>false</Boolean>
</field>
<field name="detailsAnnotations">
<Boolean>false</Boolean>
</field>
<field name="includeIndexLocalComponents">
<Boolean>false</Boolean>
</field>
<field name="showAnnotationsInDiagram">
<Boolean>true</Boolean>
</field>
<field name="filterByLanguage">
<Boolean>false</Boolean>
</field>
<field name="languageToFilter">
<String>en</String>
</field>
<field name="includeIndexResourceHierarchy">
<Boolean>true</Boolean>
</field>
<field name="unexpandedOutputFile">
<String>urdf/${cfn}.pdf</String>
</field>
<field name="splitMethod">
<Integer>3</Integer>
</field>
<field name="openOutputInBrowser">
<Boolean>true</Boolean>
</field>
<field name="format">
<Integer>2</Integer>
</field>
<field name="customXSL">
<null/>
</field>
<field name="deleteXMLFiles">
<Boolean>true</Boolean>
</field>
<field name="includeIndex">
<Boolean>true</Boolean>
</field>
<field name="copyAdditionalResources">
<Boolean>false</Boolean>
</field>
<field name="additionalResourcesDir">
<null/>
</field>
</xsdDocumentationOptions>
</entry>
</map>
</serialized>

0 comments on commit b506b9d

Please sign in to comment.