Comments (3)
Unable to use Doxide in a large existing project because even if I find-replace all these missing commands I still get stuck on this head-scratcher... an @ sign followed by a newline? Ultimately I can't make all these changes to my codebase, I need Doxide to be more forgiving about unknown commands.
error: unrecognized token starting: @
* @retval kStatus_Success
I also get thousands of warnings like this, which make me think that even if I got Doxide to build the result would be garbled:
warning: parse failed at 'uint32_t'
note: attempting recovery by erasing '__STATIC_FORCEINLINE'
New @commands
:
- Arbitrary @ signs in comments:
error: unrecognized token starting: @ 3 GHz
@addtogroup
@{
@}
@name
@date
@version
- all other supported Doxygen commands / at least don't error on them
from doxide.
Thanks for the report @zyphlar, this is helpful. To go through your issues:
-
error: unrecognized token starting: @
. This is a bug. Fix for you in 29b2e16 and new release on the way. That should get you past the error I think. -
Thousands of warnings. Yes, Doxide could do with a
--quiet
option or different levels of verbosity (I'll add a ticket for this), but if you can get past the annoyance this may be just noise. It's Doxide reporting autocorrection of perceived syntax errors that arise from preprocessor macros. An explanation of what's going on, and how to silence the warnings. If yougrep
forrecovery failed
you'll see if there is actually an error parsing that could not be autocorrected, otherwise it's all just friendly chatter. -
New commands. Suggestions noted. By way of workarounds... Sections (e.g.
@name
,@{
,@}
) I can't think of a workaround within the current feature set. Groups (e.g.@addtogroup
) are handled a little differently in Doxide, so you can use the@ingroup
style at least. For@date
and@version
the workaround would be just formatting as you please in Markdown.
from doxide.
It might be worth adding a custom command section to the YML, I kept trying to do
defines:
date: "Date: "
version: "Version: "
to get things working, and that could be a stopgap to having to implement every single command.
As for groups, I don't think we'll be able to redo all our docs to specify groups in YML and @ingroup
every single entity unfortunately, so maybe using Doxide will have to wait on that for us. (We use ad-hoc groups to organize library header files into more readable topic guides, and it would be crappy to have to centrally manage that in a second place rather than keeping all related documentation in one file, trusting that some in-file @command
is enough to properly update the docs)
from doxide.
Related Issues (20)
- Functions returning reference types are not included HOT 3
- Inner classes are not included HOT 2
- Support access specifiers HOT 1
- Doc comments not ending with a period '.' don't get a summary at all HOT 4
- In some situations, operators appear with their body, not just signature HOT 1
- Add C++ style doxygen comments HOT 10
- Verbose output HOT 2
- Provide the complete source code inside the release tarballs HOT 1
- Support unicode in identifiers HOT 1
- Add ARM packages for Linux
- Conversion operators are not extracted HOT 1
- Error while compiling doxide HOT 7
- Error while handling structure HOT 2
- Suggestion: should typedef get a separate page? HOT 1
- Suggestion: handling of mixed typedef and struct definition HOT 1
- Using /// comments break paragraphs HOT 3
- Suggestion: Documentation tests HOT 2
- Suggestion: Quiet and/or verbose mode
- Using /// breaks markdown headings HOT 4
- How to manage groups and subgroups?
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 doxide.