Comments (5)
I see.
Brief is always stricted by the text of the first row until the end period. I need to check but I think reutrn value is also added.
The problem is that if you add parameters, return value, even some would like warnings, it stops being a short brief, and opinionated what sould and should not be in a brief.
What i can do is add a flag in the configuration that lets you choose what you want to do when doxygen @brief
command is not used.
Either brief will be calculated using the first row, or brief will show the entire description with show more/less buttons.
Does that solve the issue?
from docsforge.
Attaching a screenshot of how it would look with such a flag (brief = description unless @brief
is specified)
from docsforge.
Oh, sorry that you did all that work. Actually, what I meant was to show the parameter list and the return type in the first column, together with the function name.
from docsforge.
I understand.
It was a actually a design decision not to display the parameters because it often becomes too long. Usually the the template parameters will also need to be added.
For example, for the functionbegin
https://breeze.docsforge.com/master/api/breeze/begin/#overload3 you would need to add the full synopsis:
template <typename T, std::ptrdiff_t n>
constexpr T * begin(T(&a)[n]) noexcept
So the following:
F | begin | ...
will turn to:
F | `template <typename T, std::ptrdiff_t n> constexpr T * begin(T(&a)[n]) noexcept | ...
I think it's too long for a table cell, and the focus on the overview API page should be more about brief documentation one wrote. Note that I chose a relatively short synopsis, there are far longer ones.
If you want, I can add a feature request to show the full synopsis on hover, but it's not a simple task and will take time to implement.
from docsforge.
Hi,
sorry for the very late reply. I'm not sure what the best solution is. Tooltips on hover might do it, but they are not good e.g. for mobile devices, which have no mouse pointer. Since it also takes time to implement, I'd suggest waiting a bit, to see if we can come up with a better idea (unless you have already implemented it in the meantime---sorry again for taking so long to respond).
BTW, are you interested in making DocsForge work on mobile devices? I noticed a little glitch that occurs when I browse the documentation from my phone, but wasn't sure whether reporting it or not.
Thanks.
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
- 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.