GithubHelp home page GithubHelp logo

Comments (2)

Anvil avatar Anvil commented on June 18, 2024

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.

wget avatar wget commented on June 18, 2024

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:
screenshot_20170322_170541

(notice the use of retvaland 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 retvalvariable in my own terminology. Don't know if I'm clear :) )

screenshot_20170322_170245

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.