Read a doxygen doc of a specific function #90

Activity

1. virtuald commented on Dec 17, 2023

   

   virtuald

   on Dec 17, 2023

   Last edited by virtuald

   Member

   More actions

   The PQName has a format function which turns the name into a consistent string.
2. virtuald

   closed this as completedon Dec 17, 2023
3. virtuald commented on Dec 17, 2023

   

   virtuald

   on Dec 17, 2023

   Last edited by virtuald

   Member

   More actions

   I will note that I definitely agree that using this for very simple things is still rather annoying. I'm definitely open to ideas for adding things to make it simpler to retrieve information. Or maybe someone needs to create a few examples to show how to do these things? Or add documentation.
4. tdegeus commented on Dec 18, 2023

   

   tdegeus

   on Dec 18, 2023

   Author

   More actions

   I guess that if one knows the syntax, many things are workable. The structure of C++ can be 'hard' so that a perfect and extremely syntax is never easy. I will play around and consider submitting an example for review. For now I document this example:

   from cxxheaderparser.simple import parse_string
   
   docstrings = {}
   
   data = parse_string(txt)
   for namespace in data.namespace.namespaces:
       for i in data.namespace.namespaces[namespace].functions:
           if i.doxygen:
               docstrings[f"{namespace}::{i.name.format()}"] = i.doxygen
   
       for i in data.namespace.namespaces[namespace].classes:
           class_name = i.class_decl.typename.format().split("class ")[1]
           docstrings[f"{namespace}::{class_name}"] = i.class_decl.doxygen
           for j in i.methods:
               if j.doxygen:
                   docstrings[f"{namespace}::{class_name}::{j.name.format()}"] = j.doxygen
5. virtuald commented on Dec 19, 2023

   

   virtuald

   on Dec 19, 2023

   Member

   More actions

   The class name thing is a bit weird. Probably should add a ClassDecl.get_name which returns the typename segments only without 'class' or 'typename' (so just this line:

   cxxheaderparser/cxxheaderparser/types.py

   Line 181 in 29b71ab

   return tn + "::".join(seg.format() for seg in self.segments)

   )?
6. robotpy

   locked and limited conversation to collaborators on Dec 19, 2023
7. virtuald

   converted this issue into a discussion #91 on Dec 19, 2023