Comments (2)
Hello
I thought it was a doxygen mandatory thingy. The bash-doxygen filter does nothing with @file
itself. It's just passed to doxygen. So I'm not sure if it's "regular", or not. But I can add a note in the README.md about that if needed.
About \return
and \retval
: not sure what you mean... Could you elaborate on that ?
from bash-doxygen.
Thanks for your answer. As soon we have finish our discussion here and as soon the the other issues I reported are closed, I'll rewrite the README to integrate all the elements we have discussed. :)
What I meant with \return
and \retval
is the fact this is better to return the state of the function if an error has occurred or not with number values (in this case, we use \retval
Doxygen syntax) and return the value itself using a global variable which is reset in each function with \retval
.
Here is an example in order to help you understanding what I meant:
(notice the use of retval
and return
bash statements. These have the names in reverse order compared to Doxygen terms (retval are numbers with Doxygen, while in my own Bash terminology, this is the value of retval I meant, and return is the value of the returned variable in the terms of Doxygen, but this is the value of my own retval
variable in my own terminology. Don't know if I'm clear :) )
from bash-doxygen.
Related Issues (13)
- Does not work on fedora 21. HOT 2
- Warning arguments not present HOT 4
- Use \syntax instead of @syntax
- Add support for function body prototypes
- warning: documented symbol ... was not declared or defined. HOT 1
- Trying Doxygen on MacOS with the example provided HOT 3
- Can we get Doxygen to complain about undocumented files and methods?
- Combine bash documentation with c++ documentation
- Detect functions HOT 2
- Question about bash function return values
- Build call graph HOT 1
- Functions not detected OSX El Cap (probably BSDs as well) 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 bash-doxygen.