Skip to content

Replace type by parameter name (C++) #359

@alve89

Description

@alve89

I'm using your package for documenting my C++ code. For documentation I'm using Doxygen, which expects as second part of the @param line the variable name. Your package automatically generates the variable type. Is there

  1. a way to change that quick-and-dirty and, much more important,

  2. a chance you either change that in your package or - rather - add an option in the package settings, e. g. which part of the function declaration should automatically be added?

     This is how it currently is (auto-generated comment)
     /**
      * [getTemperature description]
      * @param  byte [description]
      * @return      [description]
      */
     float getTemperature(uint8_t);
    
    
     This is how it could be with set the second part to 'variable name' 
     /**
      * [getTemperature description]
      * @param  sensorId [description]
      * @return  [description]
      */
     float getTemperature(uint8_t sensorId);
    
    
     This would be the perfect solution, but I don't know if your package can handle this
     /**
      * [getTemperature description]
      * @param  sensorId    [description]
      * @return  [description]
      */
     float getTemperature(uint8_t); // parameter name is not necessary in the declaration => get the parameter name from the cpp file, if no name is given in the declaration
    

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions