Comments (5)
Actually, what happens is that Specifies a bright red color.
is set as the brief doc, and This has the value #FF0000
is the full doc. This is no different than any other element. For the rendering, the full doc is shown if present, otherwise it is the brief doc. You should always write the full doc self-contained (i.e. should not depend on the brief doc being presented).
from cldoc.
I have modified the defect to reflect that it is with rendering index.html
-- you ninja'd your comment :).
Doxygen places the brief description before the detailed documentation for the full documentation sections so you don't have to repeat the brief description.
from cldoc.
cldoc != doxygen
from cldoc.
Fair enough. I was pointing it out as it is something that will trip people up when converting documentation from doxygen to cldoc. It will also likely lead to duplicated lines in the documentation.
Part of the problem I am having in this respect is the lack of detailed documentation on the way cldoc documentation comments are formatted and interpreted.
from cldoc.
For 1) cldoc was not really intended for conversion of doxygen, more for new projects. I don't think keeping the brief and full doc independent leads to much duplication. Brief documents are, well, brief. A single sentence without details. Making them independent leads to more readable documentation, since the full doc does not need to flow with the brief doc.
- Sure, although I think you're mostly just biased by Doxygen, and cldoc follows different conventions. That said it's a valid point, since most people will know Doxygen and have the same bias.
from cldoc.
Related Issues (20)
- Not recognizing function parameters and returns HOT 2
- Install on Arch linux fails HOT 10
- ValueError: Unknown cursor kind 601 on macOS HOT 3
- Errors when including <cstdint> HOT 2
- Support C variable arguments HOT 2
- ValueError: Unknown type kind 119 (Mac OS X Sierra)
- Unknown type kind HOT 4
- Clang 3.9 incompatibilities HOT 2
- 'friend class Bar' causes "ValueError: Unknown template argument kind 603" HOT 2
- Not working with Python3 HOT 3
- ubuntu 17.10 problem library problem with 1.11 latest release HOT 2
- TypeError: expected a string or other character buffer object HOT 2
- Passing linker arguments into cldoc is broken
- Unable to match comments if a macro is expanded before the declaration.
- Failed to run on Ubuntu 18.04 LTS HOT 6
- how to generate documentation from folder tree HOT 1
- python 3.5 compatibility HOT 1
- Is this library still maintained? HOT 1
- Links in README.md are broken HOT 1
- Python 3.10 > AttributeError: module 'collections' has no attribute 'MutableMapping'
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 cldoc.