Support Doxygen arbitrary alias\tags settings (example: use '\par' instead of '\param') #5700

Activity

1. Michelle Matias (michelleangela)

   added

   Feature Request

   Feature: Doc commentsAn issue related to code comments shown in hover, completion, and signature help.An issue related to code comments shown in hover, completion, and signature help.

   on Jun 25, 2020
2. michelleangela commented on Jun 25, 2020

   

   Michelle Matias (michelleangela)

   on Jun 25, 2020

   ContributorAuthor

   More actions

   Also, for some reason we put our Doxygen comments in between the function signature and the opening {. Doxygen parses that just fine ... will that work here as well?

   Patrick Reisert (@Boddlnagg)
   I'm not sure if I understand what you mean by "in between the function signature and the opening {". Could you provide an example for this?
3. Boddlnagg commented on Jun 25, 2020

   

   Patrick Reisert (Boddlnagg)

   on Jun 25, 2020

   More actions

   I'm not sure if I understand what you mean by "in between the function signature and the opening {". Could you provide an example for this?

   Sure:

   int foobar(int a)
   /// \brief Foos the bar
   /// \par a Something
   /// \ret Something else (or not)
   {
       return a;
   }

   (forgot to mention that we also have defined ret as an abbreviation for return)
4. Boddlnagg commented on Jun 26, 2020

   

   Patrick Reisert (Boddlnagg)

   on Jun 26, 2020

   More actions

   To elaborate on the original request: We also have defined aliases \in, \out, and \inout for \param[in], \param[out] and \param[in,out], respectively. So I think the feature would need to support arbitrary alias settings. Or the VSCode extension needs to read and the original Doxygen config and evaluate the ALIASES definitions (https://www.doxygen.nl/manual/config.html#cfg_aliases), but I don't know if that is feasible.
5. Michelle Matias (michelleangela)

   changed the title [-]Add Doxygen setting to use "\par" instead of "\param"[/-] [+]Support Doxygen arbitrary alias settings (such as to use '\par[/+] on Jun 26, 2020
6. Michelle Matias (michelleangela)

   changed the title [-]Support Doxygen arbitrary alias settings (such as to use '\par[/-] [+]Support Doxygen arbitrary alias\tags settings (example: use '\par' instead of '\param')[/+] on Jun 26, 2020
7. michelleangela commented on Jun 26, 2020

   

   Michelle Matias (michelleangela)

   on Jun 26, 2020

   ContributorAuthor

   More actions

   Patrick Reisert (@Boddlnagg)

   Thanks for the additional information.

   Please note that our team prioritizes actions on product features with broad customer impact based on telemetry data and/or upvotes of feature requests.
8. bobbrow commented on Jun 26, 2020

   

   Bob Brown (bobbrow)

   on Jun 26, 2020

   Last edited by bobbrow

   Contributor

   More actions

   It looks like there are two requests in here (additional tags, and comment position). Should we split it into two issues?
   Also, does VS Code support collapsible sections in the tooltips? If so, we could potentially place the raw comment in there as a stop gap.
9. J-Fields commented on Jul 22, 2020

   

   Jason Fields (J-Fields)

   on Jul 22, 2020

   More actions

   The formatted doxygen popup only recognizes \exception (not \throw or \throws), and \throws isn't even highlighted in the actual text.
10. michelleangela commented on Jul 22, 2020

    

    Michelle Matias (michelleangela)

    on Jul 22, 2020

    Last edited by bobbrow

    ContributorAuthor

    More actions

    The formatted doxygen popup only recognizes \exception (not \throw or \throws), and \throws isn't even highlighted in the actual text.

    To display other Doxygen comment tags, set the setting C_Cpp.simplifyStructuredComments to false. This setting was added to resolve issue #5706.
11. Bob Brown (bobbrow)

    added

    Language Service

    on Aug 13, 2020
12. Bob Brown (bobbrow)

    added this to the 0.29.0 milestone on Aug 27, 2020
13. bobbrow commented on Aug 27, 2020

    

    Bob Brown (bobbrow)

    on Aug 27, 2020

    Contributor

    More actions

    This was addressed in 0.29.0
14. Bob Brown (bobbrow)

    closed this as completedon Aug 27, 2020
15. github-actions

    locked and limited conversation to collaborators on Oct 8, 2020