Comments (3)
Thanks,
Currently, brief can either be written directly using @brief
, or created automatically, heuristically. The heuristic is simple - find the first '. ' (there's a space following the dot) or '.\n'.
I had to restrict the period to space and \n because there were too many false alarms without it. If I remember correctly, doxygen's JAVADOC_AUTOBRIEF doesn't.
"i.e." and "e.g." are special cases that end with a dot but the sentence continues.
The problem I see is that no matter how much the heuristic is improved, there will be false alarms and misdetections.
I currently prefer to keep the heuristic simple, but I'll leave the issue open.
I think that simply replacing "i.e." with "for example" in your code comments will do the trick without hindering comment readability.
from docsforge.
Thanks. "e.g." could be replaced with "for example" or "for instance", but I'm a bit hesitant to replace "i.e." with "that is", because I'm afraid that could be unclear or cause ambiguities. You could tweak the heuristic to "dot followed by space or newline but not preceded by 'i.e' or 'e.g'". Otherwise, I don't know. I'll have to invent something :-)
from docsforge.
Oh, I forgot to say: even when no "i.e." or "e.g." is involved, you can sometimes see a terminating period, sometimes not. For instance (and not "e.g." :-)), the documentation of the first two functions ends with a period, and the one of the third function doesn't.
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
- 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.