Fix readme issue in doxygen, customize css
Imitate GitHub markdown rendering
This commit is contained in:
parent
d6497d86f8
commit
6e4d8db51d
2397
build/Doxyfile
2397
build/Doxyfile
File diff suppressed because it is too large
Load Diff
1440
build/a/customdoxygen.css
Normal file
1440
build/a/customdoxygen.css
Normal file
File diff suppressed because it is too large
Load Diff
@ -119,25 +119,19 @@ When the parse processing succeeded, the `Document` contains the parse results.
|
|||||||
Parse Error Code | Description
|
Parse Error Code | Description
|
||||||
--------------------------------------------|---------------------------------------------------
|
--------------------------------------------|---------------------------------------------------
|
||||||
`kParseErrorNone` | No error.
|
`kParseErrorNone` | No error.
|
||||||
Document: |
|
|
||||||
`kParseErrorDocumentEmpty` | The document is empty.
|
`kParseErrorDocumentEmpty` | The document is empty.
|
||||||
`kParseErrorDocumentRootNotObjectOrArray` | The document root must be either object or array.
|
`kParseErrorDocumentRootNotObjectOrArray` | The document root must be either object or array.
|
||||||
`kParseErrorDocumentRootNotSingular` | The document root must not follow by other values.
|
`kParseErrorDocumentRootNotSingular` | The document root must not follow by other values.
|
||||||
Value: |
|
|
||||||
`kParseErrorValueInvalid` | Invalid value.
|
`kParseErrorValueInvalid` | Invalid value.
|
||||||
Object: |
|
|
||||||
`kParseErrorObjectMissName` | Missing a name for object member.
|
`kParseErrorObjectMissName` | Missing a name for object member.
|
||||||
`kParseErrorObjectMissColon` | Missing a colon after a name of object member.
|
`kParseErrorObjectMissColon` | Missing a colon after a name of object member.
|
||||||
`kParseErrorObjectMissCommaOrCurlyBracket` | Missing a comma or `}` after an object member.
|
`kParseErrorObjectMissCommaOrCurlyBracket` | Missing a comma or `}` after an object member.
|
||||||
Array: |
|
|
||||||
`kParseErrorArrayMissCommaOrSquareBracket` | Missing a comma or `]` after an array element.
|
`kParseErrorArrayMissCommaOrSquareBracket` | Missing a comma or `]` after an array element.
|
||||||
String: |
|
|
||||||
`kParseErrorStringUnicodeEscapeInvalidHex` | Incorrect hex digit after `\\u` escape in string.
|
`kParseErrorStringUnicodeEscapeInvalidHex` | Incorrect hex digit after `\\u` escape in string.
|
||||||
`kParseErrorStringUnicodeSurrogateInvalid` | The surrogate pair in string is invalid.
|
`kParseErrorStringUnicodeSurrogateInvalid` | The surrogate pair in string is invalid.
|
||||||
`kParseErrorStringEscapeInvalid` | Invalid escape character in string.
|
`kParseErrorStringEscapeInvalid` | Invalid escape character in string.
|
||||||
`kParseErrorStringMissQuotationMark` | Missing a closing quotation mark in string.
|
`kParseErrorStringMissQuotationMark` | Missing a closing quotation mark in string.
|
||||||
`kParseErrorStringInvalidEncoding` | Invalid encoding in string.
|
`kParseErrorStringInvalidEncoding` | Invalid encoding in string.
|
||||||
Number: |
|
|
||||||
`kParseErrorNumberTooBig` | Number too big to be stored in `double`.
|
`kParseErrorNumberTooBig` | Number too big to be stored in `double`.
|
||||||
`kParseErrorNumberMissFraction` | Miss fraction part in number.
|
`kParseErrorNumberMissFraction` | Miss fraction part in number.
|
||||||
`kParseErrorNumberMissExponent` | Miss exponent in number.
|
`kParseErrorNumberMissExponent` | Miss exponent in number.
|
||||||
|
116
doc/misc/doxygenextra.css
Normal file
116
doc/misc/doxygenextra.css
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
body code {
|
||||||
|
margin: 0;
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
background-color: #f8f8f8;
|
||||||
|
border-radius: 3px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #4183c4;
|
||||||
|
}
|
||||||
|
|
||||||
|
body, table, div, p, dl {
|
||||||
|
color: #333333;
|
||||||
|
font-family: Helvetica, arial, freesans, clean, sans-serif, 'Segoe UI Emoji', 'Segoe UI Symbol';
|
||||||
|
font-size: 15px;
|
||||||
|
font-style: normal;
|
||||||
|
font-variant: normal;
|
||||||
|
font-weight: normal;
|
||||||
|
line-height: 25.5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header {
|
||||||
|
background-image: none;
|
||||||
|
background-color: white;
|
||||||
|
margin: 0px;
|
||||||
|
border: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.headertitle {
|
||||||
|
width: 858px;
|
||||||
|
margin: 30px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.title {
|
||||||
|
font-size: 2.5em;
|
||||||
|
line-height: 63.75px;
|
||||||
|
border-bottom: 1px solid #ddd;
|
||||||
|
margin-bottom: 15px;
|
||||||
|
margin-left: 0px;
|
||||||
|
margin-right: 0px;
|
||||||
|
margin-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h2 {
|
||||||
|
font-size: 2em;
|
||||||
|
line-height: 1.7;
|
||||||
|
border-bottom: 1px solid #eee;
|
||||||
|
margin: 1em 0 15px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h3 {
|
||||||
|
font-size: 1.5em;
|
||||||
|
line-height: 1.7;
|
||||||
|
margin: 1em 0 15px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.fragment {
|
||||||
|
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
|
||||||
|
font-size: 13px;
|
||||||
|
font-style: normal;
|
||||||
|
font-variant: normal;
|
||||||
|
font-weight: normal;
|
||||||
|
line-height: 19px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.contents {
|
||||||
|
width: 858px;
|
||||||
|
margin: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.line {
|
||||||
|
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
|
||||||
|
font-size: 13px;
|
||||||
|
font-style: normal;
|
||||||
|
font-variant: normal;
|
||||||
|
font-weight: normal;
|
||||||
|
line-height: 19px;
|
||||||
|
}
|
||||||
|
|
||||||
|
tt, code, pre {
|
||||||
|
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
||||||
|
font-size: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.fragment {
|
||||||
|
background-color: #f8f8f8;
|
||||||
|
border: 1px solid #ddd;
|
||||||
|
font-size: 13px;
|
||||||
|
line-height: 19px;
|
||||||
|
overflow: auto;
|
||||||
|
padding: 6px 10px;
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectname
|
||||||
|
{
|
||||||
|
font-family: Helvetica, arial, freesans, clean, sans-serif, 'Segoe UI Emoji', 'Segoe UI Symbol';
|
||||||
|
font-size: 38px;
|
||||||
|
font-weight: bold;
|
||||||
|
line-height: 63.75px;
|
||||||
|
margin: 0px;
|
||||||
|
padding: 2px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#projectbrief
|
||||||
|
{
|
||||||
|
font-family: Helvetica, arial, freesans, clean, sans-serif, 'Segoe UI Emoji', 'Segoe UI Symbol';
|
||||||
|
font-size: 16px;
|
||||||
|
line-height: 22.4px;
|
||||||
|
margin: 0px 0px 13px 0px;
|
||||||
|
padding: 2px;
|
||||||
|
}
|
@ -10,10 +10,6 @@
|
|||||||
\todo Complete Doxygen documentation for configure macros.
|
\todo Complete Doxygen documentation for configure macros.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \mainpage
|
|
||||||
Documentation can be found in \ref readme.md README.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <cstdlib> // malloc(), realloc(), free()
|
#include <cstdlib> // malloc(), realloc(), free()
|
||||||
#include <cstring> // memcpy()
|
#include <cstring> // memcpy()
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user