Comments (6)
Yes, it's doxygen.
Doxygen's xml output in this case is:
<parameterlist kind="exception">
<parameteritem>
<parameternamelist>
<parametername>A</parametername>
</parameternamelist>
<parameterdescription>
<para>
<computeroutput>std::invalid_argument</computeroutput>
if any of the characters in
<computeroutput>s</computeroutput>
is not a decimal digit (i.e. one of
<computeroutput>0123456789</computeroutput>
).
</para>
</parameterdescription>
</parameteritem>
</parameterlist>
It thinks A is <parametername>A</parametername>
. The hyphen in docsforge is added automatically after a parameter name.
Just a suggestion - can't a \par exception
achieve your desired behavior?
from docsforge.
Yes, indeed, \par Exceptions
seems the best solution. Thanks for the suggestion, and for looking into this.
from docsforge.
Addendum: that's actually the expected behavior (if you know what to expect :-)). Because the \throw
command has a mandatory argument, which is supposed to be the type of exceptions emitted. If e.g. you follow "\throw" with "A \c std::invalid_argument", then "A" is taken as the type of exceptions, and formatted as code. In a sense, this is "logical", because \throw
wouldn't be any different from \par
, otherwise. In fact, I'd say that, given this hard-coded logic, it's probably better to just use \par
, which is more flexible.
Sorry for the bogus issue report.
from docsforge.
Addendum to the addendum :-): is the colon after "Exceptions" (the paragraph title) intentional? It seems odd at the end of a title.
from docsforge.
I agree, adding a colon is inconsistent with other paragraphs, and since it's a <dt>
element anyway, there's no need for it.
I'll fix it, thanks.
Closing, if you notice in the future that it still exists, please reopen.
from docsforge.
Fixed inconsistent colons for various titles like "Exceptions" on version 3.4.17.
from docsforge.
Related Issues (20)
- Variables added from the README documentation HOT 2
- Macros in code are causing parser errors. HOT 6
- Public Api sidebar is not displayed correctly HOT 2
- Download configuration file isn't working HOT 2
- Allow displaying doxygen's html output. HOT 2
- Add Algolia as search provider HOT 6
- Broken link in Home / Versions HOT 3
- Inconsistent punctuation in member function descriptions, and expressions like "i.e." or "e.g." HOT 3
- Missing documentation for two stream inserters
- Request: showing parameter list and return type in function descriptions HOT 5
- Thoughts about using docsforge with existing readthedocs / sphinx documentation HOT 1
- Request: adding EXTRACT_PRIV_VIRTUAL
- Related global functions shown as methods HOT 1
- Public class members other than member functions not shown
- Two enum-related problems
- "Global" language pill switching
- Suppress link generation for commonly used words
- Error generating automatic API documentation when input folder has same name as project
- ERROR!! Your sidebar section Public API has 0 pages HOT 2
- 错误,网站打不开了? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docsforge.