doxygen: decltype extraction from argstr

testingisdocumenting · Mar 1, 2024 · eceeda9 · eceeda9
1 parent 946fb26
commit eceeda9
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 0 deletions.
diff --git a/znai-docs/znai/release-notes/1.68/add-2024-02-29-doxygen-decltype.md b/znai-docs/znai/release-notes/1.68/add-2024-02-29-doxygen-decltype.md
@@ -0,0 +1 @@
+* Add: Display [Doxygen](CPP/doxygen-setup) `decltype`
diff --git a/znai-doxygen/src/main/java/org/testingisdocumenting/znai/doxygen/parser/DoxygenMember.java b/znai-doxygen/src/main/java/org/testingisdocumenting/znai/doxygen/parser/DoxygenMember.java
@@ -28,6 +28,7 @@ public class DoxygenMember {
     private DoxygenCompound compound;
     private String id;
     private String name;
+    private String declType;
     private ApiLinkedText returnType;
     private DoxygenDescription description;
     private String visibility;
@@ -97,6 +98,14 @@ public void setName(String name) {
         this.name = name;
     }
 
+    public String getDeclType() {
+        return declType;
+    }
+
+    public void setDeclType(String declType) {
+        this.declType = declType;
+    }
+
     public boolean matchesArgs(String normalizedArgsToMatch) {
         return normalizedParamsSignature.equals(normalizedArgsToMatch);
     }
@@ -192,6 +201,7 @@ public Map<String, Object> toMap() {
         result.put("name", name);
         result.put("visibility", visibility);
         result.put("kind", kind);
+        result.put("declType", declType);
         result.put("isVirtual", isVirtual);
         result.put("isFunction", isFunction());
         result.put("isConst", isConst);

diff --git a/...xygen/src/main/java/org/testingisdocumenting/znai/doxygen/parser/DoxygenMemberParser.java b/...xygen/src/main/java/org/testingisdocumenting/znai/doxygen/parser/DoxygenMemberParser.java
@@ -53,6 +53,7 @@ private void parseMember(Node memberNode) {
         member.setVirtual("virtual".equals(XmlUtils.getAttributeText(memberNode, "virt")));
         member.setConst("yes".equals(XmlUtils.getAttributeText(memberNode, "const")));
         member.setNoExcept("yes".equals(XmlUtils.getAttributeText(memberNode, "noexcept")));
+        member.setDeclType(extractDeclType(XmlUtils.nextLevelNodeByName(memberNode, "argsstring").getTextContent()));
 
         DocStructure docStructure = componentsRegistry.docStructure();
         member.setReturnType(DoxygenTextWithLinksParser.parse(docStructure,
@@ -81,4 +82,16 @@ private void parseMember(Node memberNode) {
                 DoxygenDescriptionParser.parseFull(componentsRegistry, member.getParameters(), member.getName(),
                         XmlUtils.anyNestedNodeByName(memberNode, "detaileddescription"))));
     }
+
+    /*
+      extracting decltype(expression) from argsstring. assumption that it is the last thing in the argstring xml node
+     */
+    private String extractDeclType(String args) {
+        int idx = args.indexOf("decltype(");
+        if (idx == -1) {
+            return "";
+        }
+
+        return args.substring(idx).trim();
+    }
 }
diff --git a/...c/test/groovy/org/testingisdocumenting/znai/doxygen/parser/DoxygenMemberParserTest.groovy b/...c/test/groovy/org/testingisdocumenting/znai/doxygen/parser/DoxygenMemberParserTest.groovy
@@ -40,6 +40,7 @@ class DoxygenMemberParserTest {
 
         member.id.should == 'funcs_8h_1a9fcf12f40086d563b0227b6d39b3ade7'
         member.name.should == 'my_func'
+        member.declType.should == 'decltype(par1)'
         member.static.should == false
         member.virtual.should == false
         member.const.should == true

diff --git a/znai-reactjs/src/doc-elements/doxygen/DoxygenMember.css b/znai-reactjs/src/doc-elements/doxygen/DoxygenMember.css
@@ -81,3 +81,8 @@ a .znai-doxygen-member-name {
     color: var(--znai-code-keyword-color);
     white-space: pre;
 }
+
+.znai-doxygen-member-decltype {
+    color: var(--znai-code-class-color);
+    white-space: pre;
+}
diff --git a/znai-reactjs/src/doc-elements/doxygen/DoxygenMember.demo.tsx b/znai-reactjs/src/doc-elements/doxygen/DoxygenMember.demo.tsx
@@ -59,6 +59,7 @@ export function doxygenMemberDemo(registry: Registry) {
     <DoxygenMember
       compoundName="utils::nested"
       name="my_func"
+      declType=""
       isFunction={true}
       isVirtual={false}
       isConst={false}
@@ -73,6 +74,7 @@ export function doxygenMemberDemo(registry: Registry) {
     <DoxygenMember
       compoundName="utils::nested"
       name="my_func"
+      declType=""
       isFunction={true}
       isVirtual={false}
       isConst={false}
@@ -93,6 +95,7 @@ export function doxygenMemberDemo(registry: Registry) {
       isNoExcept={false}
       compoundName=""
       name="my_func"
+      declType=""
       url="#test_link"
       returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
       parameters={parameters}
@@ -108,6 +111,7 @@ export function doxygenMemberDemo(registry: Registry) {
       isNoExcept={false}
       compoundName="utils::MyClass"
       name="my_func"
+      declType=""
       url="#test_link"
       returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
       parameters={parameters}
@@ -123,6 +127,7 @@ export function doxygenMemberDemo(registry: Registry) {
       isNoExcept={false}
       compoundName="utils::MyClass"
       name="var_name"
+      declType=""
       url="#test_link"
       returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
       parameters={[]}
@@ -138,6 +143,7 @@ export function doxygenMemberDemo(registry: Registry) {
       isNoExcept={false}
       compoundName="utils::MyClass"
       name="my_func"
+      declType=""
       url="#test_link"
       returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
       parameters={parameters}
@@ -153,6 +159,39 @@ export function doxygenMemberDemo(registry: Registry) {
       isNoExcept={true}
       compoundName="utils::MyClass"
       name="my_func"
+      declType=""
+      url="#test_link"
+      returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
+      parameters={parameters}
+    />
+  ));
+
+  registry.add("noexcept const", () => (
+    <DoxygenMember
+      isFunction={true}
+      isVirtual={false}
+      isConst={true}
+      isStatic={false}
+      isNoExcept={true}
+      compoundName="utils::MyClass"
+      name="my_func"
+      declType=""
+      url="#test_link"
+      returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
+      parameters={parameters}
+    />
+  ));
+
+  registry.add("decltype", () => (
+    <DoxygenMember
+      isFunction={true}
+      isVirtual={false}
+      isConst={false}
+      isStatic={false}
+      isNoExcept={true}
+      compoundName="utils::MyClass"
+      name="my_func"
+      declType="decltype(p1)"
       url="#test_link"
       returnType={[{ text: "MyClass", url: "#MyClass__8x" }]}
       parameters={parameters}

diff --git a/znai-reactjs/src/doc-elements/doxygen/DoxygenMember.tsx b/znai-reactjs/src/doc-elements/doxygen/DoxygenMember.tsx
@@ -27,6 +27,7 @@ import "./DoxygenMember.css";
 interface Props {
   compoundName: string;
   name: string;
+  declType: string;
   url?: string;
   isFunction: boolean;
   isStatic: boolean;
@@ -41,6 +42,7 @@ interface Props {
 export function DoxygenMember({
   compoundName,
   name,
+  declType,
   url,
   returnType,
   isFunction,
@@ -115,6 +117,7 @@ export function DoxygenMember({
               {isFunction && <div className="znai-doxygen-member-params-separator">)</div>}
               {isConst && <div className="znai-doxygen-member-classifier"> const</div>}
               {isNoExcept && <div className="znai-doxygen-member-classifier"> noexcept</div>}
+              {declType && <div className="znai-doxygen-member-decltype"> -&gt; {declType}</div>}
             </div>
           )}
         </div>