GithubHelp home page GithubHelp logo

Warning arguments not present about bash-doxygen HOT 4 OPEN

wget avatar wget commented on June 9, 2024
Warning arguments not present

from bash-doxygen.

Comments (4)

Anvil avatar Anvil commented on June 9, 2024

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.

wget avatar wget commented on June 9, 2024

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.

Anvil avatar Anvil commented on June 9, 2024

The warnings go away if you do @param $string, and @param $delimiter instead.

from bash-doxygen.

Anvil avatar Anvil commented on June 9, 2024

Maybe the solution is to generate pseudo-php instead of pseudo-C. I'll dig into that.

from bash-doxygen.

Related Issues (13)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.