Comments (4)
Well, removing the warning is quite easy (see 13dd671). But (there's always a but), I understand we now have to have a type for each parameter, and I aesthetically don't like that idea.
from bash-doxygen.
Indeed, this is quite awful. I tested with PHP and indeed since the language is dynamically typed, and even if PHP is officially supported by doxygen, I even have warnings with this language :-/.
<?php
/** \file */
/**
* Hello world
* \brief this is a simple hello world
* \param string the string
* \param delimiter the delimiter
*/
function helloWorld($string, $delimiter) {
echo "$string, $delimiter"
}
?>
test.php:6: warning: argument 'string' of command @param is not found in the argument list of helloWorld($string, $delimiter)
test.php:6: warning: argument 'delimiter' of command @param is not found in the argument list of helloWorld($string, $delimiter)
test.php:11: warning: The following parameters of helloWorld($string, $delimiter) are not documented:
parameter '$string'
parameter '$delimiter'
The solution would be to specify an invisible type in the regex. Therefore, I tried to use the sed whitespace syntax (\s
), but is isn't working. Do you have any idea?
Also, I tried to allow documentation on lines with a shift (one or several 4 tabs or none), I added this feature to the regex, but it seems this isn't taken into account. Do you have any idea about this as well?
example:
## @defgroup Colors Define a color as a variable string
## @{
## @addtogroup Colors
## @var textBlack
## @brief Define text in black
export textBlack="�[30m"
[...]
## @}
from bash-doxygen.
The warnings go away if you do @param $string
, and @param $delimiter
instead.
from bash-doxygen.
Maybe the solution is to generate pseudo-php instead of pseudo-C. I'll dig into that.
from bash-doxygen.
Related Issues (13)
- Does not work on fedora 21. HOT 2
- 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
- Not working if the .sh file does not have a @file statement HOT 2
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.