issue #9713 Variables show in "Related Functions" section

Created new translation text for related symbols, by default the old text is used.
(variables, typedefs and enums were already shown with the Related Functions header, so are now under the new header).

Author: albert-github

src/context.cpp

@@ -942,7 +942,7 @@ class TranslateContext::Private
     }
     TemplateVariant related() const
     {
-      return theTranslator->trRelatedFunctions();
+      return theTranslator->trRelatedSymbols();
     }
     TemplateVariant macros() const
     {
@@ -2123,7 +2123,7 @@ class ClassContext::Private : public DefinitionContext<ClassContext::Private>
     }
     TemplateVariant createRelated() const
     {
-      return createMemberList(MemberListType_related,theTranslator->trRelatedFunctions());
+      return createMemberList(MemberListType_related,theTranslator->trRelatedSymbols());
     }
     TemplateVariant createDetailedTypedefs() const
     {
@@ -2151,7 +2151,7 @@ class ClassContext::Private : public DefinitionContext<ClassContext::Private>
     }
     TemplateVariant createDetailedRelated() const
     {
-      return createMemberList(MemberListType_relatedMembers,theTranslator->trRelatedFunctionDocumentation());
+      return createMemberList(MemberListType_relatedMembers,theTranslator->trRelatedSymbolDocumentation());
     }
     TemplateVariant createDetailedVariables() const
     {
@@ -2264,7 +2264,7 @@ class ClassContext::Private : public DefinitionContext<ClassContext::Private>
       ctx->addMemberList(m_classDef,MemberListType_priStaticMethods,theTranslator->trStaticPrivateMembers());
       ctx->addMemberList(m_classDef,MemberListType_priAttribs,theTranslator->trPrivateAttribs());
       ctx->addMemberList(m_classDef,MemberListType_priStaticAttribs,theTranslator->trStaticPrivateAttribs());
-      ctx->addMemberList(m_classDef,MemberListType_related,theTranslator->trRelatedFunctions());
+      ctx->addMemberList(m_classDef,MemberListType_related,theTranslator->trRelatedSymbols());
       return list;
     }
     void addMembers(MemberList &list,const ClassDef *cd,MemberListType lt) const

src/index.cpp

@@ -2958,7 +2958,7 @@ static const CmhlInfo *getCmhlInfo(size_t hl)
     CmhlInfo("functions_eval",theTranslator->trEnumerationValues()),
     CmhlInfo("functions_prop",theTranslator->trProperties()),
     CmhlInfo("functions_evnt",theTranslator->trEvents()),
-    CmhlInfo("functions_rela",theTranslator->trRelatedFunctions())
+    CmhlInfo("functions_rela",theTranslator->trRelatedSymbols())
   };
   return &cmhlInfo[hl];
 }

src/layout.cpp

@@ -947,8 +947,8 @@ static const std::map< std::string, ElementCallbacks > g_elementHandlers =
                                                     endCb()
                                                   } },
   { "class/memberdecl/related",                   { startCb(&LayoutParser::startMemberDeclEntry, MemberListType_related,
-                                                            []() { return compileOptions(theTranslator->trRelatedFunctions()); },
-                                                            []() { return compileOptions(theTranslator->trRelatedSubscript()); }),
+                                                            []() { return compileOptions(theTranslator->trRelatedSymbols()); },
+                                                            []() { return compileOptions(theTranslator->trRelatedSymbolsSubscript()); }),
                                                     endCb()
                                                   } },
   { "class/memberdef",                            { startCb(&LayoutParser::startMemberDef),
@@ -986,7 +986,7 @@ static const std::map< std::string, ElementCallbacks > g_elementHandlers =
                                                     endCb()
                                                   } },
   { "class/memberdef/related",                    { startCb(&LayoutParser::startMemberDefEntry, MemberListType_relatedMembers,
-                                                            []() { return compileOptions(theTranslator->trRelatedFunctionDocumentation()); }),
+                                                            []() { return compileOptions(theTranslator->trRelatedSymbolDocumentation()); }),
                                                     endCb()
                                                   } },
   { "class/memberdef/variables",                  { startCb(&LayoutParser::startMemberDefEntry, MemberListType_variableMembers,

src/translator.h

@@ -727,6 +727,13 @@ class Translator
 // new since 1.9.6
 //////////////////////////////////////////////////////////////////////////
     virtual QCString trFlowchart() = 0;
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.9.7
+//////////////////////////////////////////////////////////////////////////
+    virtual QCString trRelatedSymbols() = 0;
+    virtual QCString trRelatedSymbolsSubscript() = 0;
+    virtual QCString trRelatedSymbolDocumentation() = 0;
 };
 
 #endif

src/translator_adapter.h

@@ -40,7 +40,22 @@ class TranslatorAdapterBase : public Translator
 
 };
 
-class TranslatorAdapter_1_9_5 : public TranslatorAdapterBase
+class TranslatorAdapter_1_9_6 : public TranslatorAdapterBase
+{
+  public:
+    virtual QCString updateNeededMessage()
+    { return createUpdateNeededMessage(idLanguage(),"release 1.9.5"); }
+
+    /*! Small trick to use the original functions as the wording has been changed */
+    virtual QCString trRelatedSymbols()
+    { return trRelatedFunctions(); }
+    virtual QCString trRelatedSymbolsSubscript()
+    { return trRelatedSubscript(); }
+    virtual QCString trRelatedSymbolDocumentation()
+    { return trRelatedFunctionDocumentation(); }
+};
+
+class TranslatorAdapter_1_9_5 : public TranslatorAdapter_1_9_6
 {
   public:
     virtual QCString updateNeededMessage()

src/translator_br.h

@@ -58,7 +58,7 @@
 #ifndef TRANSLATOR_BR_H
 #define TRANSLATOR_BR_H
 
-class TranslatorBrazilian : public Translator
+class TranslatorBrazilian : public TranslatorAdapter_1_9_6
 {
   public:
 

src/translator_cz.h

@@ -129,7 +129,7 @@
  Translator class (by the local maintainer) when the localized
  translator is made up-to-date again.
 */
-class TranslatorCzech : public Translator
+class TranslatorCzech : public TranslatorAdapter_1_9_6
 {
   public:
 

src/translator_en.h

@@ -2349,6 +2349,32 @@ class TranslatorEnglish : public Translator
      *  trMemberFunctionDocumentation(), now better adapted for
      *  VHDL sources documentation.
      */
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.9.7
+//////////////////////////////////////////////////////////////////////////
+    /*! used in the compound documentation before a list of related symbols.
+     *
+     *  Supersedes trRelatedFunctions
+     */
+    virtual QCString trRelatedSymbols()
+    { return "Related Symbols"; }
+
+    /*! subscript for the related symbols
+     *
+     *  Supersedes trRelatedSubscript
+     */
+    virtual QCString trRelatedSymbolsSubscript()
+    { return "(Note that these are not member symbols.)"; }
+
+    /*! used in the class documentation as a header before the list of all
+     * related classes.
+     *
+     * Supersedes trRelatedFunctionDocumentation
+     */
+    virtual QCString trRelatedSymbolDocumentation()
+    { return "Friends And Related Symbol Documentation"; }
+
 };
 
 #endif

src/translator_es.h

@@ -31,7 +31,7 @@
  * Updated to 1.8.4 by Bartomeu Creus Navarro (17-julio-2013)
  * Updated to 1.9.6 by David H. Martín (28-diciembre-2022)
 */
-class TranslatorSpanish : public Translator
+class TranslatorSpanish : public TranslatorAdapter_1_9_6
 {
   public:
 

src/translator_nl.h

@@ -1900,6 +1900,32 @@ class TranslatorDutch : public Translator
      *  VHDL sources documentation.
      *  Done.
      */
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.9.7
+//////////////////////////////////////////////////////////////////////////
+    /*! used in the compound documentation before a list of related symbols.
+     *
+     *  Supersedes trRelatedFunctions
+     */
+    virtual QCString trRelatedSymbols()
+    { return "Gerelateerde symbolen"; }
+
+    /*! subscript for the related symbols
+     *
+     *  Supersedes trRelatedSubscript
+     */
+    virtual QCString trRelatedSymbolsSubscript()
+    { return "(Merk op dat dit geen member symbolen zijn.)"; }
+
+    /*! used in the class documentation as a header before the list of all
+     * related classes.
+     *
+     * Supersedes trRelatedFunctionDocumentation
+     */
+    virtual QCString trRelatedSymbolDocumentation()
+    { return "Documentatie van friends en gerelateerde symbolen"; }
+
 };
 
 #endif