Anvil / bash-doxygen

A doxygen filter for bash scripts
Do What The F*ck You Want To Public License
91 stars 24 forks source link

warning: documented symbol ... was not declared or defined. #15

Closed ericbutters closed 6 years ago

ericbutters commented 6 years ago
#!/bin/bash

## @file      test.sh
## @brief     Simple demo to for debug of bash-doxygen issue
## @author    Eric Butters
## @date      2018-02-07
## @copyright CLOSED
## @details   none

## @fn abc
## @brief echo ABC
function abc() {
   echo "ABC"
}

## @fn def
## @brief echo DEF
function def() {
   echo "DEF"
}

abc
def

# THIS WILL RESULT IN WARNINGS AND NOT CORRECT DOCUMENTATION
# test.sh:10: warning: documented symbol `abc' was not declared or defined.
# test.sh:16: warning: documented symbol `abc' was not declared or defined.
ericbutters commented 6 years ago

got it, ## @fn abc needs ()