Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • dumux dumux
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 96
    • Issues 96
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 98
    • Merge requests 98
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • dumux-repositories
  • dumuxdumux
  • Issues
  • #136
Closed
Open
Created Feb 27, 2012 by Christoph Grüninger@gruenichMaintainer

FS#136 Make \\copydoc consistent

Metadata

Property Value
Project dumux
Category General
Reported by Christoph Grüninger (gruenich@iws.uni-stuttgart.de)
Reported at Feb 27, 2012 16:02
Type Bug Report
Version Git
Last edited by Christoph Grüninger (gruenich@iws.uni-stuttgart.de)
Last edited at Oct 5, 2012 14:10
Closed by Christoph Grüninger (gruenich@iws.uni-stuttgart.de)
Closed at Oct 5, 2012 14:10
Closed in version 2.2
Resolution Fixed

Description

This is the appendix of FS#23. Klaus wrote:

[using \\copydoc]
The problem is that if the arguments have different names in the derived class as in the parent class (where the documentation is copied from), Doxygen will spit out warnings and the names of the arguments are taken from the parent class. That means they won\'t fit to the argument names of the actually documented function. 

[..]

 - If \\copydoc is used, the argument names should be exactly the same; thus we can agree for these cases on some fixed names (at least for common object names such as fvElementGeometry, scvIdx/vertexIdx, etc.). So far, these names are varying sometimes even within one file, which is in my opinion not too consistent.
 - Moreover, we could keep the issue with the argument names in mind when creating new methods and documenting them with \\copydoc.
Assignee
Assign to
Time tracking