From 841b9705f10c9dc9a5b3c60da4a590863e18e5b4 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 3 Apr 2020 19:23:19 +0200 Subject: Rewrite C++ bindings --- doc/layout.xml | 1 + doc/mainpage.md | 4 +-- doc/reference.doxygen.in | 20 ++++++------- doc/style.css | 73 ++++++++++++++++++++++++++++++++++++++++++------ 4 files changed, 77 insertions(+), 21 deletions(-) (limited to 'doc') diff --git a/doc/layout.xml b/doc/layout.xml index 1889302..4744245 100644 --- a/doc/layout.xml +++ b/doc/layout.xml @@ -25,6 +25,7 @@ + diff --git a/doc/mainpage.md b/doc/mainpage.md index aa6f925..c04bf9e 100644 --- a/doc/mainpage.md +++ b/doc/mainpage.md @@ -1,6 +1,6 @@ This is the API documentation for Pugl. -This documentation is based around the [C API](@ref pugl_api), -there is also a [C++ API](@ref pugl) in the `pugl` namespace. +This page refers to the [C API](@ref pugl_c), +there is also a [C++ API](@ref pugl_cxx) in the `pugl` namespace. The Pugl API revolves around two main objects: the [World](@ref world) and the [View](@ref view). diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index 1357fe4..833085c 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -447,7 +447,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -498,7 +498,7 @@ EXTRACT_ANON_NSPACES = NO # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. -HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set @@ -506,7 +506,7 @@ HIDE_UNDOC_MEMBERS = YES # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. -HIDE_UNDOC_CLASSES = YES +HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be @@ -543,7 +543,7 @@ CASE_SENSE_NAMES = YES # scope will be hidden. # The default value is: NO. -HIDE_SCOPE_NAMES = NO +HIDE_SCOPE_NAMES = YES # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to @@ -752,7 +752,7 @@ WARNINGS = YES # will automatically be disabled. # The default value is: YES. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters @@ -769,7 +769,7 @@ WARN_IF_DOC_ERROR = YES # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. -WARN_NO_PARAMDOC = YES +WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. @@ -1165,7 +1165,7 @@ HTML_EXTRA_FILES = # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_HUE = 160 +HTML_COLORSTYLE_HUE = 120 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A @@ -1173,7 +1173,7 @@ HTML_COLORSTYLE_HUE = 160 # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_SAT = 32 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 @@ -1930,7 +1930,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -2090,7 +2090,7 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = PUGL_API PUGL_DISABLE_DEPRECATED +PREDEFINED = PUGL_API PUGL_DISABLE_DEPRECATED PUGL_CONST_FUNC= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/doc/style.css b/doc/style.css index 28f0519..680fe77 100644 --- a/doc/style.css +++ b/doc/style.css @@ -233,6 +233,14 @@ div.groupHeader { font-weight: 700; } +h2.groupheader { + line-height: 1.18em; + font-size: 1em; + font-weight: 600; + font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif; + margin: 1.25em 0 0.5em 0; +} + a + h2.groupheader { display: none; } @@ -387,6 +395,18 @@ table.memberdecls { line-height: 1.3em; } +table.memberdecls h3 { + line-height: 1.18em; + font-size: 1em; + font-weight: 600; + font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif; + margin: 1.25em 0 0.5em 0; +} + +tr.inherit_header td { + padding: 1em 0 0.5em 0; +} + .mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams { margin: 0; padding: 0; @@ -419,13 +439,28 @@ td.memSeparator { display: none; } +td.mlabels-left { + margin-left: 0; + padding-left: 0; +} + td.mlabels-right { - vertical-align: top; - padding-top: 4px; color: #B4C342; + font-weight: normal; + margin-left: 1em; + vertical-align: bottom; } .memtitle { + border-bottom: 1px solid #EEE; + font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif; + font-size: 1.18em; + font-weight: 600; + line-height: 1.41em; + margin: 1.5em 0 0 0; +} + +.permalink { display: none; } @@ -446,18 +481,20 @@ td.mlabels-right { } .memitem { - padding: 0.5em 0.5em 0.25em 0.5em; - margin: 1em 0 2em 0; + padding: 0; + margin: 0 0 3em 0; } .memproto { border-bottom: 1px solid #EEE; + border-left: 1px solid #EEE; + color: #444; + float: right; font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed; - font-size: 1.09em; - font-weight: 600; - line-height: 1.41em; - margin-bottom: 0.25em; - padding-bottom: 0.125em; + font-size: small; + margin-bottom: 1em; + margin-left: 1em; + padding: 0.25em 0 0.25em 0.25em; } .memproto .paramname { @@ -465,6 +502,11 @@ td.mlabels-right { padding-right: 0.25em; } +.mlabels { + padding-left: 0; + padding-right: 0; +} + .memdoc { padding: 0; } @@ -473,6 +515,19 @@ td.mlabels-right { font-style: italic; color: #444; margin-bottom: 0.75em; + margin-top: 0; + padding-top: 0.25em; + font-weight: normal; +} + +.memdoc > p:first-child, .memdoc .textblock > h3:first-child { + color: #444; + margin-bottom: 0.75em; + margin-top: 0; + padding-top: 0.25em; + font-weight: normal; + color: #444; + font-size: 0.9em; } .paramkey { -- cgit v1.2.1