Doxygen
Loading...
Searching...
No Matches
TranslatorPersian Class Reference

#include <src/translator_fa.h>

Inheritance diagram for TranslatorPersian:
Collaboration diagram for TranslatorPersian:

Public Member Functions

DString idLanguage () override
DString latexLanguageSupportCommand () override
DString latexCommandName () override
DString trISOLang () override
DString getLanguageString () override
 language codes for Html help
DString trRelatedFunctions () override
DString trRelatedSubscript () override
DString trDetailedDescription () override
DString trDetails () override
DString trMemberTypedefDocumentation () override
DString trMemberEnumerationDocumentation () override
DString trMemberFunctionDocumentation () override
DString trMemberDataDocumentation () override
DString trMore () override
DString trListOfAllMembers () override
DString trMemberList () override
DString trThisIsTheListOfAllMembers () override
DString trIncludingInheritedMembers () override
DString trGeneratedAutomatically (const DString &s) override
DString trEnumName () override
DString trEnumValue () override
DString trDefinedIn () override
DString trModules () override
DString trClassHierarchy () override
DString trCompoundList () override
DString trFileList () override
DString trCompoundMembers () override
DString trFileMembers () override
DString trRelatedPages () override
DString trExamples () override
DString trSearch () override
DString trClassHierarchyDescription () override
DString trFileListDescription (bool extractAll) override
DString trCompoundListDescription () override
DString trCompoundMembersDescription (bool extractAll) override
DString trFileMembersDescription (bool extractAll) override
DString trExamplesDescription () override
DString trRelatedPagesDescription () override
DString trModulesDescription () override
DString trDocumentation (const DString &projName) override
DString trModuleIndex () override
DString trHierarchicalIndex () override
DString trCompoundIndex () override
DString trFileIndex () override
DString trModuleDocumentation () override
DString trClassDocumentation () override
DString trFileDocumentation () override
DString trReferenceManual () override
DString trDefines () override
DString trTypedefs () override
DString trEnumerations () override
DString trFunctions () override
DString trVariables () override
DString trEnumerationValues () override
DString trDefineDocumentation () override
DString trTypedefDocumentation () override
DString trEnumerationTypeDocumentation () override
DString trEnumerationValueDocumentation () override
DString trFunctionDocumentation () override
DString trVariableDocumentation () override
DString trCompounds () override
DString trGeneratedAt (const DString &date, const DString &projName) override
DString trClassDiagram (const DString &clName) override
DString trWarning () override
DString trVersion () override
DString trDate () override
DString trReturns () override
DString trSeeAlso () override
DString trParameters () override
DString trExceptions () override
DString trGeneratedBy () override
DString trNamespaceList () override
DString trNamespaceListDescription (bool extractAll) override
DString trFriends () override
DString trRelatedFunctionDocumentation () override
DString trCompoundReference (const DString &clName, ClassDef::CompoundType compType, bool isTemplate) override
DString trFileReference (const DString &fileName) override
DString trNamespaceReference (const DString &namespaceName) override
DString trPublicMembers () override
DString trPublicSlots () override
DString trSignals () override
DString trStaticPublicMembers () override
DString trProtectedMembers () override
DString trProtectedSlots () override
DString trStaticProtectedMembers () override
DString trPrivateMembers () override
DString trPrivateSlots () override
DString trStaticPrivateMembers () override
DString trWriteList (int numEntries) override
DString trInheritsList (int numEntries) override
DString trInheritedByList (int numEntries) override
DString trReimplementedFromList (int numEntries) override
DString trReimplementedInList (int numEntries) override
DString trNamespaceMembers () override
DString trNamespaceMemberDescription (bool extractAll) override
DString trNamespaceIndex () override
DString trNamespaceDocumentation () override
DString trNamespaces () override
DString trGeneratedFromFiles (ClassDef::CompoundType compType, bool single) override
DString trReturnValues () override
DString trMainPage () override
DString trPageAbbreviation () override
DString trDefinedAtLineInSourceFile () override
DString trDefinedInSourceFile () override
DString trDeprecated () override
DString trCollaborationDiagram (const DString &clName) override
DString trInclDepGraph (const DString &fName) override
DString trConstructorDocumentation () override
DString trGotoSourceCode () override
DString trGotoDocumentation () override
DString trPrecondition () override
DString trPostcondition () override
DString trInvariant () override
DString trInitialValue () override
DString trCode () override
DString trGraphicalHierarchy () override
DString trGotoGraphicalHierarchy () override
DString trGotoTextualHierarchy () override
DString trPageIndex () override
DString trNote () override
DString trPublicTypes () override
DString trPublicAttribs () override
DString trStaticPublicAttribs () override
DString trProtectedTypes () override
DString trProtectedAttribs () override
DString trStaticProtectedAttribs () override
DString trPrivateTypes () override
DString trPrivateAttribs () override
DString trStaticPrivateAttribs () override
DString trTodo () override
DString trTodoList () override
DString trReferencedBy () override
DString trRemarks () override
DString trAttention () override
DString trInclByDepGraph () override
DString trSince () override
DString trLegendTitle () override
DString trLegendDocs () override
DString trLegend () override
DString trTest () override
DString trTestList () override
DString trProperties () override
DString trPropertyDocumentation () override
DString trClasses () override
DString trPackage (const DString &name) override
DString trPackageListDescription () override
DString trPackages () override
DString trDefineValue () override
DString trBug () override
DString trBugList () override
DString trRTFansicp () override
DString trRTFCharSet () override
DString trRTFGeneralIndex () override
DString trClass (bool first_capital, bool singular) override
DString trFile (bool, bool singular) override
DString trNamespace (bool first_capital, bool singular) override
DString trGroup (bool first_capital, bool singular) override
DString trPage (bool first_capital, bool singular) override
DString trMember (bool first_capital, bool singular) override
DString trGlobal (bool first_capital, bool singular) override
DString trAuthor (bool first_capital, bool singular) override
DString trReferences () override
DString trImplementedFromList (int numEntries) override
DString trImplementedInList (int numEntries) override
DString trRTFTableOfContents () override
DString trDeprecatedList () override
DString trEvents () override
DString trEventDocumentation () override
DString trPackageTypes () override
DString trPackageFunctions () override
DString trPackageMembers () override
DString trStaticPackageFunctions () override
DString trPackageAttribs () override
DString trStaticPackageAttribs () override
DString trAll () override
DString trCallGraph () override
DString trSearchResultsTitle () override
DString trSearchResults (int numDocuments) override
DString trSearchMatches () override
DString trSourceFile (const DString &filename) override
DString trDirIndex () override
DString trDirDocumentation () override
DString trDirectories () override
DString trDirReference (const DString &dirName) override
DString trDir (bool, bool singular) override
DString trOverloadText () override
DString trCallerGraph () override
DString trMemberFunctionDocumentationFortran () override
DString trCompoundListFortran () override
DString trCompoundMembersFortran () override
DString trCompoundListDescriptionFortran () override
DString trCompoundMembersDescriptionFortran (bool) override
DString trCompoundIndexFortran () override
DString trTypeDocumentation () override
DString trSubprograms () override
DString trSubprogramDocumentation () override
DString trDataTypes () override
DString trModulesList () override
DString trModulesListDescription (bool) override
DString trCompoundReferenceFortran (const DString &clName, ClassDef::CompoundType compType, bool isTemplate) override
DString trModuleReference (const DString &namespaceName) override
DString trModulesMembers () override
DString trModulesMemberDescription (bool) override
DString trModulesIndex () override
DString trModule (bool, bool singular) override
DString trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single) override
DString trType (bool first_capital, bool singular) override
DString trSubprogram (bool, bool singular) override
DString trTypeConstraints () override
DString trDirRelation (const DString &name) override
DString trLoading () override
DString trGlobalNamespace () override
DString trSearching () override
DString trNoMatches () override
DString trFileIn (const DString &name) override
DString trIncludesFileIn (const DString &name) override
DString trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime) override
 Compiles a date string.
DString trDayOfWeek (int dayOfWeek, bool, bool full) override
DString trMonth (int month, bool, bool full) override
DString trDayPeriod (bool period) override
Public Member Functions inherited from TranslatorAdapter_1_7_5
DString updateNeededMessage () override
DString trCiteReferences () override
DString trCopyright () override
DString trDirDepGraph (const DString &name) override
Public Member Functions inherited from TranslatorAdapter_1_8_0
DString updateNeededMessage () override
DString trDetailLevel () override
DString trTemplateParameters () override
DString trAndMore (const DString &number) override
DString trEnumGeneratedFromFiles (bool single) override
DString trEnumReference (const DString &name) override
DString trInheritedFrom (const DString &members, const DString &what) override
DString trAdditionalInheritedMembers () override
Public Member Functions inherited from TranslatorAdapter_1_8_2
DString updateNeededMessage () override
DString trPanelSynchronisationTooltip (bool enable) override
DString trProvidedByCategory () override
DString trExtendsClass () override
DString trClassMethods () override
DString trInstanceMethods () override
DString trMethodDocumentation () override
Public Member Functions inherited from TranslatorAdapter_1_8_4
DString updateNeededMessage () override
DString trInterfaces () override
DString trServices () override
DString trConstantGroups () override
DString trConstantGroupReference (const DString &namespaceName) override
DString trServiceReference (const DString &sName) override
DString trSingletonReference (const DString &sName) override
DString trServiceGeneratedFromFiles (bool single) override
DString trSingletonGeneratedFromFiles (bool single) override
Public Member Functions inherited from TranslatorAdapter_1_8_15
DString trDesignUnitHierarchy () override
DString trDesignUnitList () override
DString trDesignUnitMembers () override
DString trDesignUnitListDescription () override
DString trDesignUnitIndex () override
DString trDesignUnits () override
DString trFunctionAndProc () override
DString trVhdlType (VhdlSpecifier type, bool single) override
DString trCustomReference (const DString &name) override
DString trConstants () override
DString trConstantDocumentation () override
DString trSequences () override
DString trSequenceDocumentation () override
DString trDictionaries () override
DString trDictionaryDocumentation () override
DString trSliceInterfaces () override
DString trInterfaceIndex () override
DString trInterfaceList () override
DString trInterfaceListDescription () override
DString trInterfaceHierarchy () override
DString trInterfaceHierarchyDescription () override
DString trInterfaceDocumentation () override
DString trStructs () override
DString trStructIndex () override
DString trStructList () override
DString trStructListDescription () override
DString trStructDocumentation () override
DString trExceptionIndex () override
DString trExceptionList () override
DString trExceptionListDescription () override
DString trExceptionHierarchy () override
DString trExceptionHierarchyDescription () override
DString trExceptionDocumentation () override
DString trCompoundReferenceSlice (const DString &clName, ClassDef::CompoundType compType, bool isLocal) override
DString trOperations () override
DString trOperationDocumentation () override
DString trDataMembers () override
DString trDataMemberDocumentation () override
Public Member Functions inherited from TranslatorAdapter_1_8_19
DString trDesignUnitDocumentation () override
Public Member Functions inherited from TranslatorAdapter_1_9_2
DString updateNeededMessage () override
DString trConcept (bool first_capital, bool singular) override
DString trConceptReference (const DString &conceptName) override
DString trConceptList () override
DString trConceptIndex () override
DString trConceptDocumentation () override
DString trConceptListDescription (bool extractAll) override
DString trConceptDefinition () override
Public Member Functions inherited from TranslatorAdapter_1_9_4
DString updateNeededMessage () override
DString trPackageList () override
Public Member Functions inherited from TranslatorAdapter_1_9_5
DString updateNeededMessage () override
DString trFlowchart () override
Public Member Functions inherited from TranslatorAdapter_1_9_6
DString updateNeededMessage () override
DString trRelatedSymbols () override
DString trRelatedSymbolsSubscript () override
DString trRelatedSymbolDocumentation () override
DString trCompoundType (ClassDef::CompoundType compType, SrcLangExt lang) override
DString trFileMembersDescriptionTotal (FileMemberHighlight::Enum hl) override
DString trCompoundMembersDescriptionTotal (ClassMemberHighlight::Enum hl) override
DString trNamespaceMembersDescriptionTotal (NamespaceMemberHighlight::Enum hl) override
DString trDefinition () override
DString trDeclaration () override
Public Member Functions inherited from TranslatorAdapter_1_9_8
DString updateNeededMessage () override
DString trTopics () override
DString trTopicDocumentation () override
DString trTopicList () override
DString trTopicIndex () override
DString trTopicListDescription () override
DString trModuleMembersDescriptionTotal (ModuleMemberHighlight::Enum hl) override
DString trExportedModules () override
Public Member Functions inherited from TranslatorAdapter_1_10_0
DString trCopyToClipboard () override
Public Member Functions inherited from TranslatorAdapter_1_11_0
DString trImportant () override
Public Member Functions inherited from TranslatorAdapter_1_16_0
DString trRequirements () override
DString trRequirementID () override
DString trSatisfies (bool singular) override
DString trSatisfiedBy (const DString &list) override
DString trUnsatisfiedRequirements () override
DString trUnsatisfiedRequirementsText (bool singular, const DString &list) override
DString trVerifies (bool singular) override
DString trVerifiedBy (const DString &list) override
DString trUnverifiedRequirements () override
DString trUnverifiedRequirementsText (bool singular, const DString &list) override
Public Member Functions inherited from Translator
virtual DString latexFontenc ()
virtual DString latexFont ()
virtual DString latexDocumentPre ()
virtual DString latexDocumentPost ()
virtual bool needsPunctuation ()
 add punctuation at the end of a brief description when needed and supported by the language

Private Member Functions

DString convertDigitsToFarsi (DString str)
 Converts english digits of an input string to persian equivalents.

Additional Inherited Members

Protected Member Functions inherited from TranslatorAdapterBase
DString createUpdateNeededMessage (const DString &languageName, const DString &versionString)
Protected Member Functions inherited from Translator
DString p_latexCommandName (const DString &latexCmd)
DString createNoun (bool first_capital, bool singular, const DString &base, const DString &plurSuffix, const DString &singSuffix="")
Protected Attributes inherited from TranslatorAdapterBase
TranslatorEnglish english

Detailed Description

Definition at line 42 of file translator_fa.h.

Member Function Documentation

◆ convertDigitsToFarsi()

DString TranslatorPersian::convertDigitsToFarsi ( DString str)
inlineprivate

Converts english digits of an input string to persian equivalents.

Definition at line 47 of file translator_fa.h.

48 {
49 DString output;
50 const char * PersianDigits[] = { "۰", "۱", "۲", "۳", "۴", "۵", "۶", "۷", "۸", "۹" };
51 for(unsigned i=0; i<str.length(); i++)
52 {
53 if (str.at(i) >= '0' && str.at(i) <= '9')
54 output += PersianDigits[ str.at(i) - '0' ];
55 else
56 output += str.at(i);
57 }
58
59 return output;
60 }
char & at(size_t i)
Returns a reference to the character at index i.
Definition dstring.h:675
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition dstring.h:156

References DString::at(), and DString::length().

Referenced by trDateTime().

◆ getLanguageString()

DString TranslatorPersian::getLanguageString ( )
inlineoverridevirtual

language codes for Html help

 0x402 Bulgarian
 0x405 Czech
 0x406 Danish
 0x413 Dutch
 0xC09 English (Australia)
 0x809 English (Britain)
 0x1009 English (Canada)
 0x1809 English (Ireland)
 0x1409 English (New Zealand)
 0x1C09 English (South Africa)
 0x409 English (United States)
 0x40B Finnish
 0x40C French
 0x407 German
 0x408 Greece
 0x439 Hindi
 0x40E Hungarian
 0x410 Italian
 0x814 Norwegian
 0x415 Polish
 0x816 Portuguese(Portugal)
 0x416 Portuguese(Brazil)
 0x419 Russian
 0x80A Spanish(Mexico)
 0xC0A Spanish(Modern Sort)
 0x40A Spanish(Traditional Sort)
 0x41D Swedish
 0x41F Turkey
 0x411 Japanese
 0x412 Korean
 0x804 Chinese (PRC)
 0x404 Chinese (Taiwan)
 

New LCIDs:

 0x421 Indonesian
 0x41A Croatian
 0x418 Romanian
 0x424 Slovenian
 0x41B Slovak
 0x422 Ukrainian
 0x81A Serbian (Serbia, Latin)
 0x403 Catalan
 0x426 Latvian
 0x427 Lithuanian
 0x436 Afrikaans
 0x42A Vietnamese
 0x429 Persian (Iran)
 0xC01 Arabic (Egypt) - I don't know which version of arabic is used inside translator_ar.h ,
       so I have chosen Egypt at random
 

Code for Esperanto should be as shown below but the htmlhelp compiler 1.3 does not support this (and no newer version is available).

0x48f Esperanto

So do a fallback to the default language

0x409 English (United States)
0xC1A Serbian (Serbia, Cyrillic)

Implements Translator.

Definition at line 104 of file translator_fa.h.

105 {
106 return "0x429 Persian (Iran)";
107 }

◆ idLanguage()

DString TranslatorPersian::idLanguage ( )
inlineoverridevirtual

Used for identification of the language. The identification should not be translated. It should be replaced by the name of the language in Persian using lower-case characters only (e.g. "czech", "japanese", "russian", etc.). It should be equal to the identification used in language.cpp.

Implements Translator.

Definition at line 72 of file translator_fa.h.

73 { return "persian"; }

◆ latexCommandName()

DString TranslatorPersian::latexCommandName ( )
inlineoverridevirtual

Set the name to be used as latex command.

Reimplemented from Translator.

Definition at line 94 of file translator_fa.h.

95 {
96 return p_latexCommandName("xelatex");
97 }
DString p_latexCommandName(const DString &latexCmd)
Definition translator.h:788

References Translator::p_latexCommandName().

◆ latexLanguageSupportCommand()

DString TranslatorPersian::latexLanguageSupportCommand ( )
inlineoverridevirtual

Used to get the LaTeX command(s) for the language support. This method should return string with commands that switch LaTeX to the desired language. For example

"\\usepackage[german]{babel}\n"
 

or

"\\usepackage{polski}\n"
 "\\usepackage[latin2]{inputenc}\n"
 "\\usepackage[T1]{fontenc}\n"
 

The Persian LaTeX does not use such commands. Because of this the empty string is returned in this implementation.

Implements Translator.

Definition at line 89 of file translator_fa.h.

90 {
91 return "";
92 }

◆ trAll()

DString TranslatorPersian::trAll ( )
inlineoverridevirtual

Used in the quick index of a class/file/namespace member list page to link to the unfiltered list of all members.

Implements Translator.

Definition at line 1398 of file translator_fa.h.

1399 {
1400 return "همه";
1401 }

◆ trAttention()

DString TranslatorPersian::trAttention ( )
inlineoverridevirtual

Implements Translator.

Definition at line 962 of file translator_fa.h.

963 {
964 return "توجه";
965 }

◆ trAuthor()

DString TranslatorPersian::trAuthor ( bool first_capital,
bool singular )
inlineoverridevirtual

This text is generated when the \author command is used and for the author section in man pages.

Implements Translator.

Definition at line 1269 of file translator_fa.h.

1270 {
1271 DString result((first_capital ? "Author" : "author"));
1272 if (!singular) result+="s";
1273 return result;
1274 }

◆ trBug()

DString TranslatorPersian::trBug ( )
inlineoverridevirtual

Used as a marker that is put before a \bug item

Implements Translator.

Definition at line 1127 of file translator_fa.h.

1128 {
1129 return "اشکال";
1130 }

◆ trBugList()

DString TranslatorPersian::trBugList ( )
inlineoverridevirtual

Used as the header of the bug list

Implements Translator.

Definition at line 1132 of file translator_fa.h.

1133 {
1134 return "ليست اشکالات";
1135 }

◆ trCallerGraph()

DString TranslatorPersian::trCallerGraph ( )
inlineoverridevirtual

This is used to introduce a caller (or called-by) graph

Implements Translator.

Definition at line 1519 of file translator_fa.h.

1520 {
1521 return "نمودار صدا زننده های این تابع:";
1522 }

◆ trCallGraph()

DString TranslatorPersian::trCallGraph ( )
inlineoverridevirtual

Put in front of the call graph for a function.

Implements Translator.

Definition at line 1403 of file translator_fa.h.

1404 {
1405 return "نمودار صدا زدن برای این تابع :";
1406 }

◆ trClass()

DString TranslatorPersian::trClass ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1190 of file translator_fa.h.

1191 {
1192 DString result((first_capital ? "کلاس" : "کلاس"));
1193 if (!singular) result+="ها";
1194 return result;
1195 }

◆ trClassDiagram()

DString TranslatorPersian::trClassDiagram ( const DString & clName)
inlineoverridevirtual

this text is put before a class diagram

Implements Translator.

Definition at line 519 of file translator_fa.h.

520 {
521 return ""+clName+" نمودار وراثت برای :";
522 }

◆ trClassDocumentation()

DString TranslatorPersian::trClassDocumentation ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter containing the documentation of all classes, structs and unions.

Implements Translator.

Definition at line 394 of file translator_fa.h.

395 {
396 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
397 {
398 return "مستندات ساختار داده ها";
399 }
400 else if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
401 {
403 }
404 else
405 {
406 return "مستندات کلاس ها";
407 }
408 }
virtual DString trDesignUnitDocumentation()=0
#define Config_getBool(name)
Definition config.h:33

References Config_getBool, and TranslatorAdapter_1_8_19::trDesignUnitDocumentation().

◆ trClasses()

DString TranslatorPersian::trClasses ( )
inlineoverridevirtual

Used for Java classes in the summary section of Java packages

Implements Translator.

Definition at line 1090 of file translator_fa.h.

1091 {
1092 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
1093 {
1094 return "ساختار های داده";
1095 }
1096 else
1097 {
1098 return "كلاس ها";
1099 }
1100 }

References Config_getBool.

◆ trClassHierarchy()

DString TranslatorPersian::trClassHierarchy ( )
inlineoverridevirtual

This is put above each page as a link to the class hierarchy

Implements Translator.

Definition at line 202 of file translator_fa.h.

203 { return "سلسله مراتب کلاس ها"; }

◆ trClassHierarchyDescription()

DString TranslatorPersian::trClassHierarchyDescription ( )
inlineoverridevirtual

This is an introduction to the class hierarchy.

Implements Translator.

Definition at line 261 of file translator_fa.h.

262 { return "ليست و سلسله مراتب درختی کلاس ها به صورت مرتب شده :";
263 }

◆ trCode()

DString TranslatorPersian::trCode ( )
inlineoverridevirtual

Text used the source code in the file index

Implements Translator.

Definition at line 862 of file translator_fa.h.

863 {
864 return "کد";
865 }

◆ trCollaborationDiagram()

DString TranslatorPersian::trCollaborationDiagram ( const DString & clName)
inlineoverridevirtual

this text is put before a collaboration diagram

Implements Translator.

Definition at line 817 of file translator_fa.h.

818 {
819 return "Collaboration diagram for "+clName+":";
820 }

◆ trCompoundIndex()

DString TranslatorPersian::trCompoundIndex ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the annotated compound index.

Implements Translator.

Definition at line 367 of file translator_fa.h.

368 {
369 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
370 {
371 return "فهرست ساختار داده ها";
372 }
373 else
374 {
375 return "فهرست کلاس های";
376 }
377 }

References Config_getBool.

◆ trCompoundIndexFortran()

DString TranslatorPersian::trCompoundIndexFortran ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the annotated compound index (Fortran).

Implements Translator.

Definition at line 1552 of file translator_fa.h.

1553 { return "Data Type Index"; }

◆ trCompoundList()

DString TranslatorPersian::trCompoundList ( )
inlineoverridevirtual

This is put above each page as a link to the list of annotated classes

Implements Translator.

Definition at line 206 of file translator_fa.h.

207 {
208 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
209 {
210 return "ساختار های داده ";
211 }
212 else
213 {
214 return "ليست کلاس ها ";
215 }
216 }

References Config_getBool.

◆ trCompoundListDescription()

DString TranslatorPersian::trCompoundListDescription ( )
inlineoverridevirtual

This is an introduction to the annotated compound list.

Implements Translator.

Definition at line 275 of file translator_fa.h.

276 {
277
278 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
279 {
280 return "ليست ساختارهای داده به همراه توضيحی کوتاه :";
281 }
282 else
283 {
284 return "ليست کلاس ها ، ساختارهای داده و ... به همراه توضيحات مختصر راجع به آنها :";
285 }
286 }

References Config_getBool.

◆ trCompoundListDescriptionFortran()

DString TranslatorPersian::trCompoundListDescriptionFortran ( )
inlineoverridevirtual

This is an introduction to the annotated compound list (Fortran).

Implements Translator.

Definition at line 1540 of file translator_fa.h.

1541 { return "ساختارهای داده به همراه توضیح کوتاه :"; }

◆ trCompoundListFortran()

DString TranslatorPersian::trCompoundListFortran ( )
inlineoverridevirtual

This is put above each page as a link to the list of annotated data types (Fortran).

Implements Translator.

Definition at line 1532 of file translator_fa.h.

1533 { return "لیست ساختار های داده"; }

◆ trCompoundMembers()

DString TranslatorPersian::trCompoundMembers ( )
inlineoverridevirtual

This is put above each page as a link to all members of compounds.

Implements Translator.

Definition at line 223 of file translator_fa.h.

224 {
225 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
226 {
227 return "فضاهای داده ها";
228 }
229 else
230 {
231 return "اعضاء کلاس ها";
232 }
233 }

References Config_getBool.

◆ trCompoundMembersDescription()

DString TranslatorPersian::trCompoundMembersDescription ( bool extractAll)
inlineoverridevirtual

This is an introduction to the page with all class members.

Implements Translator.

Definition at line 289 of file translator_fa.h.

290 {
291 DString result=" در ذيل ليست ";
292 if (!extractAll)
293 {
294 result+="آن اعضايي که مستند شده اند ";
295 }
296 else
297 {
298 result+="همه ی اعضاء ";
299 }
300 result+=" به همراه ارتباطشان با ";
301 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
302 {
303 result+="ساختارهای داده ";
304 }
305 else
306 {
307 result+="كلاس ها ";
308 }
309
310 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
311 {
312 result+="و مستندات ساختار داده برای هر عضو ";
313 }
314 else
315 {
316 result+="و مستندات کلاس برای هر عضو ";
317 }
318 result+="را مشاهده ميکنيد :";
319 return result;
320 }

References Config_getBool.

◆ trCompoundMembersDescriptionFortran()

DString TranslatorPersian::trCompoundMembersDescriptionFortran ( bool )
inlineoverridevirtual

This is an introduction to the page with all data types (Fortran).

Implements Translator.

Definition at line 1544 of file translator_fa.h.

1545 {
1546 return "توضیحات اعضا ساختارها به همراه مستندات ساختار داده ی مربوطه";
1547 }

◆ trCompoundMembersFortran()

DString TranslatorPersian::trCompoundMembersFortran ( )
inlineoverridevirtual

This is put above each page as a link to all members of compounds (Fortran).

Implements Translator.

Definition at line 1536 of file translator_fa.h.

1537 { return "فیلدهای اطلاعات"; }

◆ trCompoundReference()

DString TranslatorPersian::trCompoundReference ( const DString & clName,
ClassDef::CompoundType compType,
bool isTemplate )
inlineoverridevirtual

used as the title of the HTML page of a class/struct/union

Implements Translator.

Definition at line 594 of file translator_fa.h.

597 {
598 DString result;
599 switch(compType)
600 {
601 case ClassDef::Class: result=" کلاس"; break;
602 case ClassDef::Struct: result=" ساختار داده"; break;
603 case ClassDef::Union: result=" Union"; break;
604 case ClassDef::Interface: result=" Interface"; break;
605 case ClassDef::Protocol: result=" Protocol"; break;
606 case ClassDef::Category: result=" Category"; break;
607 case ClassDef::Exception: result=" استثناء"; break;
608 default: break;
609 }
610 if (isTemplate) result+=" قالب";
611 result=clName + " مرجع" +result ;
612 return result;
613 }
@ Interface
Definition classdef.h:112
@ Exception
Definition classdef.h:115

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct, and ClassDef::Union.

◆ trCompoundReferenceFortran()

DString TranslatorPersian::trCompoundReferenceFortran ( const DString & clName,
ClassDef::CompoundType compType,
bool isTemplate )
inlineoverridevirtual

used as the title of the HTML page of a module/type (Fortran)

Implements Translator.

Definition at line 1591 of file translator_fa.h.

1594 {
1595 DString result=clName;
1596 switch(compType)
1597 {
1598 case ClassDef::Class: result+=" Module"; break;
1599 case ClassDef::Struct: result+=" Type"; break;
1600 case ClassDef::Union: result+=" Union"; break;
1601 case ClassDef::Interface: result+=" Interface"; break;
1602 case ClassDef::Protocol: result+=" Protocol"; break;
1603 case ClassDef::Category: result+=" Category"; break;
1604 case ClassDef::Exception: result+=" Exception"; break;
1605 default: break;
1606 }
1607 if (isTemplate) result+=" Template";
1608 result+=" Reference";
1609 return result;
1610 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct, and ClassDef::Union.

◆ trCompounds()

DString TranslatorPersian::trCompounds ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace/group before the list of links to documented compounds

Implements Translator.

Definition at line 495 of file translator_fa.h.

496 {
497 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
498 {
499 return "ساختارهای داده";
500 }
501 else
502 {
503 return "کلاس ها";
504 }
505 }

References Config_getBool.

◆ trConstructorDocumentation()

DString TranslatorPersian::trConstructorDocumentation ( )
inlineoverridevirtual

header that is put before the list of constructor/destructors.

Implements Translator.

Definition at line 827 of file translator_fa.h.

828 {
829 return "مستندات توباع آغازین و پایانی";
830 }

◆ trDataTypes()

DString TranslatorPersian::trDataTypes ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace/group before the list of links to documented compounds (Fortran)

Implements Translator.

Definition at line 1576 of file translator_fa.h.

1577 { return "ساختار های داده"; }

◆ trDate()

DString TranslatorPersian::trDate ( )
inlineoverridevirtual

this text is generated when the \date command is used.

Implements Translator.

Definition at line 533 of file translator_fa.h.

534 { return "تاريخ"; }

◆ trDateTime()

DString TranslatorPersian::trDateTime ( int year,
int month,
int day,
int dayOfWeek,
int hour,
int minutes,
int seconds,
DateTimeType includeTime )
inlineoverridevirtual

Compiles a date string.

Parameters
yearYear in 4 digits
monthMonth of the year: 1=January
dayDay of the Month: 1..31
dayOfWeekDay of the week: 1=Monday..7=Sunday
hourHour of the day: 0..23
minutesMinutes in the hour: 0..59
secondsSeconds within the minute: 0..59
includeTimeInclude time in the result string?

Reimplemented from TranslatorAdapter_1_7_5.

Definition at line 1760 of file translator_fa.h.

1763 {
1764 static const char *days[] = { "دوشنبه","سه‌شنبه","چهارشنبه","پنجشنبه","جمعه","شنبه","یکشنبه" };
1765 static const char *months[] = { "ژانویه","فوریه","مارس","آوریل","می","جون","جولای","آگوست","سپتامبر","اکتبر","نوامبر","دسامبر" };
1766 DString sdate;
1767 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Date)
1768 {
1769 sdate.sprintf("%s %d %s %d",days[dayOfWeek-1],day,months[month-1],year);
1770 }
1771 if (includeTime == DateTimeType::DateTime) sdate += " ";
1772 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Time)
1773 {
1774 DString stime;
1775 stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);
1776 sdate+=stime;
1777 }
1778 return convertDigitsToFarsi(sdate);
1779 }
DString & sprintf(const char *format,...)
Definition dstring.cpp:29
DString convertDigitsToFarsi(DString str)
Converts english digits of an input string to persian equivalents.

References convertDigitsToFarsi(), Date, DateTime, DString::sprintf(), and Time.

◆ trDayOfWeek()

DString TranslatorPersian::trDayOfWeek ( int dayOfWeek,
bool ,
bool full )
inlineoverridevirtual

Implements Translator.

Definition at line 1780 of file translator_fa.h.

1781 {
1782 static const char *days_short[] = { "دوشنبه", "سه شنبه", "چهارشنبه", "پنجشنبه", "جمعه", "شنبه", "يكشنبه" };
1783 static const char *days_full[] = { "دوشنبه", "سه شنبه", "چهارشنبه", "پنجشنبه", "جمعه", "شنبه", "يكشنبه" };
1784 DString text = full? days_full[dayOfWeek-1] : days_short[dayOfWeek-1];
1785 return text;
1786 }

◆ trDayPeriod()

DString TranslatorPersian::trDayPeriod ( bool period)
inlineoverridevirtual

Reimplemented from TranslatorAdapter_1_7_5.

Definition at line 1794 of file translator_fa.h.

1795 {
1796 static const char *dayPeriod[] = { "قبل‌ازظهر", "بعدازظهر" };
1797 return dayPeriod[period?1:0];
1798 }

◆ trDefinedAtLineInSourceFile()

DString TranslatorPersian::trDefinedAtLineInSourceFile ( )
inlineoverridevirtual

Implements Translator.

Definition at line 794 of file translator_fa.h.

795 {
796 return ".در خط @0 از پرونده @1 تعريف شده است";
797 }

◆ trDefinedIn()

DString TranslatorPersian::trDefinedIn ( )
inlineoverridevirtual

put after an undocumented member in the list of all members

Implements Translator.

Definition at line 190 of file translator_fa.h.

191 { return "تعریف شده در"; }

◆ trDefinedInSourceFile()

DString TranslatorPersian::trDefinedInSourceFile ( )
inlineoverridevirtual

Implements Translator.

Definition at line 798 of file translator_fa.h.

799 {
800 return ".در فايل @0 تعريف شده است";
801 }

◆ trDefineDocumentation()

DString TranslatorPersian::trDefineDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file before the list of documentation blocks for defines

Implements Translator.

Definition at line 459 of file translator_fa.h.

460 { return "Define Documentation"; }

◆ trDefines()

DString TranslatorPersian::trDefines ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of defines

Implements Translator.

Definition at line 423 of file translator_fa.h.

424 { return "تعاريف"; }

◆ trDefineValue()

DString TranslatorPersian::trDefineValue ( )
inlineoverridevirtual

Text shown before a multi-line define

Implements Translator.

Definition at line 1117 of file translator_fa.h.

1118 {
1119 return "مقدار:";
1120 }

◆ trDeprecated()

DString TranslatorPersian::trDeprecated ( )
inlineoverridevirtual

Implements Translator.

Definition at line 807 of file translator_fa.h.

808 {
809 return "منسوخ شده";
810 }

◆ trDeprecatedList()

DString TranslatorPersian::trDeprecatedList ( )
inlineoverridevirtual

Used as the header of the list of item that have been flagged deprecated

Implements Translator.

Definition at line 1326 of file translator_fa.h.

1327 {
1328 return "لیست آیتم های از رده خارج";
1329 }

◆ trDetailedDescription()

DString TranslatorPersian::trDetailedDescription ( )
inlineoverridevirtual

header that is put before the detailed description of files, classes and namespaces.

Implements Translator.

Definition at line 119 of file translator_fa.h.

120 { return "توضيحات جزئی"; }

◆ trDetails()

DString TranslatorPersian::trDetails ( )
inlineoverridevirtual

header that is used when the summary tag is missing inside the details tag

Implements Translator.

Definition at line 123 of file translator_fa.h.

124 { return "جزئیات"; }

◆ trDir()

DString TranslatorPersian::trDir ( bool ,
bool singular )
inlineoverridevirtual

This returns the word directory with or without starting capital (first_capital) and in singular or plural form (singular).

Implements Translator.

Definition at line 1493 of file translator_fa.h.

1494 {
1495 DString result("شاخه");
1496 if (singular) result+=" ها "+result;
1497 return result;
1498 }

◆ trDirDocumentation()

DString TranslatorPersian::trDirDocumentation ( )
inlineoverridevirtual

This is used as the name of the chapter containing the documentation of the directories.

Implements Translator.

Definition at line 1475 of file translator_fa.h.

1476 { return "مستندات دايرکتوری"; }

◆ trDirectories()

DString TranslatorPersian::trDirectories ( )
inlineoverridevirtual

This is used as the title of the directory index and also in the Quick links of an HTML page, to link to the directory hierarchy.

Implements Translator.

Definition at line 1481 of file translator_fa.h.

1482 { return "شاخه ها"; }

◆ trDirIndex()

DString TranslatorPersian::trDirIndex ( )
inlineoverridevirtual

This is used as the name of the chapter containing the directory hierarchy.

Implements Translator.

Definition at line 1469 of file translator_fa.h.

1470 { return "ساختار و سلسله مراتب شاخه ها"; }

◆ trDirReference()

DString TranslatorPersian::trDirReference ( const DString & dirName)
inlineoverridevirtual

This returns the title of a directory page. The name of the directory is passed via dirName.

Implements Translator.

Definition at line 1487 of file translator_fa.h.

1488 { DString result=dirName; result+=" مرجع شاخه ی"; return result; }

◆ trDirRelation()

DString TranslatorPersian::trDirRelation ( const DString & name)
inlineoverridevirtual

directory relation for name

Implements Translator.

Definition at line 1699 of file translator_fa.h.

1700 {
1701 return name + " Relation";
1702 }

◆ trDocumentation()

DString TranslatorPersian::trDocumentation ( const DString & projName)
inlineoverridevirtual

This is used in HTML as the title of index.html.

Implements Translator.

Definition at line 349 of file translator_fa.h.

350 { return "مستندات" + (!projName.empty()?" " + projName : ""); }
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:153

References DString::empty().

◆ trEnumerations()

DString TranslatorPersian::trEnumerations ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of enumerations

Implements Translator.

Definition at line 435 of file translator_fa.h.

436 { return "تعاريف"; }

◆ trEnumerationTypeDocumentation()

DString TranslatorPersian::trEnumerationTypeDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace before the list of documentation blocks for enumeration types

Implements Translator.

Definition at line 471 of file translator_fa.h.

472 { return "مستندات تعريف"; }

◆ trEnumerationValueDocumentation()

DString TranslatorPersian::trEnumerationValueDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace before the list of documentation blocks for enumeration values

Implements Translator.

Definition at line 477 of file translator_fa.h.

478 { return "مستندات معرف"; }

◆ trEnumerationValues()

DString TranslatorPersian::trEnumerationValues ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of (global) variables

Implements Translator.

Definition at line 453 of file translator_fa.h.

454 { return "معرف ها"; }

◆ trEnumName()

DString TranslatorPersian::trEnumName ( )
inlineoverridevirtual

put after an enum name in the list of all members

Implements Translator.

Definition at line 182 of file translator_fa.h.

183 { return "enum نام"; }

◆ trEnumValue()

DString TranslatorPersian::trEnumValue ( )
inlineoverridevirtual

put after an enum value in the list of all members

Implements Translator.

Definition at line 186 of file translator_fa.h.

187 { return "enum مقدار"; }

◆ trEventDocumentation()

DString TranslatorPersian::trEventDocumentation ( )
inlineoverridevirtual

Header used for the documentation section of a class' events.

Implements Translator.

Definition at line 1343 of file translator_fa.h.

1344 {
1345 return "مستندات رویداد";
1346 }

◆ trEvents()

DString TranslatorPersian::trEvents ( )
inlineoverridevirtual

Used as a header for declaration section of the events found in a C# program

Implements Translator.

Definition at line 1338 of file translator_fa.h.

1339 {
1340 return "رویداد ها";
1341 }

◆ trExamples()

DString TranslatorPersian::trExamples ( )
inlineoverridevirtual

This is put above each page as a link to all examples.

Implements Translator.

Definition at line 253 of file translator_fa.h.

254 { return "مثال ها"; }

◆ trExamplesDescription()

DString TranslatorPersian::trExamplesDescription ( )
inlineoverridevirtual

This is an introduction to the page with the list of all examples

Implements Translator.

Definition at line 334 of file translator_fa.h.

335 { return "ليست همه ی مثال ها :"; }

◆ trExceptions()

DString TranslatorPersian::trExceptions ( )
inlineoverridevirtual

this text is generated when the \exception command is used.

Implements Translator.

Definition at line 549 of file translator_fa.h.

550 { return "استثناء ها"; }

◆ trFile()

DString TranslatorPersian::trFile ( bool ,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1201 of file translator_fa.h.

1202 {
1203 DString result("پرونده");
1204 if (!singular) result=result+" ها";
1205 return result;
1206 }

◆ trFileDocumentation()

DString TranslatorPersian::trFileDocumentation ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter containing the documentation of all files.

Implements Translator.

Definition at line 413 of file translator_fa.h.

414 { return "مستندات فایل"; }

◆ trFileIn()

DString TranslatorPersian::trFileIn ( const DString & name)
inlineoverridevirtual

when clicking a directory dependency label, a page with a table is shown. The heading for the first column mentions the source file that has a relation to another file.

Reimplemented from TranslatorAdapter_1_7_5.

Definition at line 1736 of file translator_fa.h.

1737 {
1738 return "پرونده ای در "+name;
1739 }

◆ trFileIndex()

DString TranslatorPersian::trFileIndex ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the list of all files.

Implements Translator.

Definition at line 382 of file translator_fa.h.

383 { return "فهرست پرونده ها"; }

◆ trFileList()

DString TranslatorPersian::trFileList ( )
inlineoverridevirtual

This is put above each page as a link to the list of documented files

Implements Translator.

Definition at line 219 of file translator_fa.h.

220 { return "ليست فايل ها"; }

◆ trFileListDescription()

DString TranslatorPersian::trFileListDescription ( bool extractAll)
inlineoverridevirtual

This is an introduction to the list with all files.

Implements Translator.

Definition at line 266 of file translator_fa.h.

267 {
268 DString result="ليست همه ي پرونده های ";
269 if (!extractAll) result+="(مستند شده) ";
270 result+=" :";
271 return result;
272 }

◆ trFileMembers()

DString TranslatorPersian::trFileMembers ( )
inlineoverridevirtual

This is put above each page as a link to all members of files.

Implements Translator.

Definition at line 236 of file translator_fa.h.

237 {
238 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
239 {
240 return "Globals";
241 }
242 else
243 {
244 return "اعضاء پرونده";
245 }
246 }

References Config_getBool.

◆ trFileMembersDescription()

DString TranslatorPersian::trFileMembersDescription ( bool extractAll)
inlineoverridevirtual

This is an introduction to the page with all file members.

Implements Translator.

Definition at line 323 of file translator_fa.h.

324 {
325 DString result="ليست همه ی توابع ، متغيير ها، تعاريف و ... ";
326 if (!extractAll) result+="(مستند شده) ";
327
328 result+=" به همراه ارتباط آنها ";
329 result+="با پرونده هايی که به آن مربوط اند :";
330 return result;
331 }

◆ trFileReference()

DString TranslatorPersian::trFileReference ( const DString & fileName)
inlineoverridevirtual

used as the title of the HTML page of a file

Implements Translator.

Definition at line 616 of file translator_fa.h.

617 {
618 DString result=fileName;
619 result+=" مرجع پرونده";
620 return result;
621 }

◆ trFriends()

DString TranslatorPersian::trFriends ( )
inlineoverridevirtual

used in the class documentation as a header before the list of all friends of a class

Implements Translator.

Definition at line 576 of file translator_fa.h.

577 { return "کلاس های دوست"; }

◆ trFunctionDocumentation()

DString TranslatorPersian::trFunctionDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace before the list of documentation blocks for functions

Implements Translator.

Definition at line 483 of file translator_fa.h.

484 { return "توضيح تابع"; }

◆ trFunctions()

DString TranslatorPersian::trFunctions ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of (global) functions

Implements Translator.

Definition at line 441 of file translator_fa.h.

442 { return "توابع"; }

◆ trGeneratedAt()

DString TranslatorPersian::trGeneratedAt ( const DString & date,
const DString & projName )
inlineoverridevirtual

This is used in the standard footer of each page and indicates when the page was generated

Implements Translator.

Definition at line 510 of file translator_fa.h.

511 {
512 DString result = HtmlDivEnd + HtmlRightToLeft + DString("توليد شده در ") +date ;
513 if (!projName.empty()) result+=" برای "+projName;
514 result+=" توسط";
515 return result;
516 }
DString()=default
#define HtmlDivEnd
#define HtmlRightToLeft

References DString::DString(), DString::empty(), HtmlDivEnd, and HtmlRightToLeft.

◆ trGeneratedAutomatically()

DString TranslatorPersian::trGeneratedAutomatically ( const DString & s)
inlineoverridevirtual

this is put at the author sections at the bottom of man pages. parameter s is name of the project name.

Implements Translator.

Definition at line 174 of file translator_fa.h.

175 { DString result="تولید شده توسط نرم افزار دی اکسیژن ";
176 if (!s.empty()) result+=" برای "+s;
177 result+=" از کد برنامه ";
178 return result;
179 }

References DString::empty().

◆ trGeneratedBy()

DString TranslatorPersian::trGeneratedBy ( )
inlineoverridevirtual

this text is used in the title page of a LaTeX document.

Implements Translator.

Definition at line 553 of file translator_fa.h.

554 { return "توليد شده توسط"; }

◆ trGeneratedFromFiles()

DString TranslatorPersian::trGeneratedFromFiles ( ClassDef::CompoundType compType,
bool single )
inlineoverridevirtual

This is put at the bottom of a class documentation page and is followed by a list of files that were used to generate the page.

Implements Translator.

Definition at line 750 of file translator_fa.h.

752 { // here s is one of " Class", " Struct" or " Union"
753 // single is true implies a single file
754 DString result="مستندات اين ";
755 switch(compType)
756 {
757 case ClassDef::Class: result+="کلاس"; break;
758 case ClassDef::Struct: result+="ساختار داده"; break;
759 case ClassDef::Union: result+="union"; break;
760 case ClassDef::Interface: result+="interface"; break;
761 case ClassDef::Protocol: result+="protocol"; break;
762 case ClassDef::Category: result+="category"; break;
763 case ClassDef::Exception: result+="exception"; break;
764 default: break;
765 }
766 result+=" از روی پرونده ";
767 if (single) result+=""; else result+="های ";
768 result+="زير توليد شده است :";
769 return result;
770 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct, and ClassDef::Union.

◆ trGeneratedFromFilesFortran()

DString TranslatorPersian::trGeneratedFromFilesFortran ( ClassDef::CompoundType compType,
bool single )
inlineoverridevirtual

This is put at the bottom of a module documentation page and is followed by a list of files that were used to generate the page.

Implements Translator.

Definition at line 1649 of file translator_fa.h.

1651 { // here s is one of " Module", " Struct" or " Union"
1652 // single is true implies a single file
1653 DString result="The documentation for this ";
1654 switch(compType)
1655 {
1656 case ClassDef::Class: result+="module"; break;
1657 case ClassDef::Struct: result+="type"; break;
1658 case ClassDef::Union: result+="union"; break;
1659 case ClassDef::Interface: result+="interface"; break;
1660 case ClassDef::Protocol: result+="protocol"; break;
1661 case ClassDef::Category: result+="category"; break;
1662 case ClassDef::Exception: result+="exception"; break;
1663 default: break;
1664 }
1665 result+=" was generated from the following file";
1666 if (single) result+=":"; else result+="s:";
1667 return result;
1668 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct, and ClassDef::Union.

◆ trGlobal()

DString TranslatorPersian::trGlobal ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1256 of file translator_fa.h.

1257 {
1258 DString result((first_capital ? "Global" : "global"));
1259 if (!singular) result+="s";
1260 return result;
1261 }

◆ trGlobalNamespace()

DString TranslatorPersian::trGlobalNamespace ( )
inlineoverridevirtual

Label used for search results in the global namespace

Implements Translator.

Definition at line 1711 of file translator_fa.h.

1712 {
1713 return "فضای نام جهانی";
1714 }

◆ trGotoDocumentation()

DString TranslatorPersian::trGotoDocumentation ( )
inlineoverridevirtual

Used in the file sources to point to the corresponding documentation.

Implements Translator.

Definition at line 837 of file translator_fa.h.

838 {
839 return "توضيحات اين پرونده.";
840 }

◆ trGotoGraphicalHierarchy()

DString TranslatorPersian::trGotoGraphicalHierarchy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 870 of file translator_fa.h.

871 {
872 return "نمایش نمودار درختی گرافیکی کلاس";
873 }

◆ trGotoSourceCode()

DString TranslatorPersian::trGotoSourceCode ( )
inlineoverridevirtual

Used in the file documentation to point to the corresponding sources.

Implements Translator.

Definition at line 832 of file translator_fa.h.

833 {
834 return "کد منبع اين پرونده.";
835 }

◆ trGotoTextualHierarchy()

DString TranslatorPersian::trGotoTextualHierarchy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 874 of file translator_fa.h.

875 {
876 return "نمایش نمودار درختی متنی کلاس";
877 }

◆ trGraphicalHierarchy()

DString TranslatorPersian::trGraphicalHierarchy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 866 of file translator_fa.h.

867 {
868 return "سلسله مراتب گرافيکی کلاس";
869 }

◆ trGroup()

DString TranslatorPersian::trGroup ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1223 of file translator_fa.h.

1224 {
1225 DString result((first_capital ? "Group" : "group"));
1226 if (!singular) result+="s";
1227 return result;
1228 }

◆ trHierarchicalIndex()

DString TranslatorPersian::trHierarchicalIndex ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the class hierarchy.

Implements Translator.

Definition at line 361 of file translator_fa.h.

362 { return "فهرست سلسله مراتب"; }

◆ trImplementedFromList()

DString TranslatorPersian::trImplementedFromList ( int numEntries)
inlineoverridevirtual

used in member documentation blocks to produce a list of members that are implemented by this one.

Implements Translator.

Definition at line 1294 of file translator_fa.h.

1295 {
1296 return "را تکميل می کند "+trWriteList(numEntries)+".";
1297 }
DString trWriteList(int numEntries) override

References trWriteList().

◆ trImplementedInList()

DString TranslatorPersian::trImplementedInList ( int numEntries)
inlineoverridevirtual

used in member documentation blocks to produce a list of all members that implement this abstract member.

Implements Translator.

Definition at line 1302 of file translator_fa.h.

1303 {
1304 return ".تکميل شده است "+trWriteList(numEntries)+" در";
1305 }

References trWriteList().

◆ trInclByDepGraph()

DString TranslatorPersian::trInclByDepGraph ( )
inlineoverridevirtual

Implements Translator.

Definition at line 966 of file translator_fa.h.

967 {
968 return "این نمودار فایل هایی را که این فایل را به طور مستقیم یا غیر مستقیم استفاده کرده اند نشان می دهد";
969 }

◆ trInclDepGraph()

DString TranslatorPersian::trInclDepGraph ( const DString & fName)
inlineoverridevirtual

this text is put before an include dependency graph

Implements Translator.

Definition at line 822 of file translator_fa.h.

823 {
824 return "نمودار شامل شدن ها برای "+fName+":";
825 }

◆ trIncludesFileIn()

DString TranslatorPersian::trIncludesFileIn ( const DString & name)
inlineoverridevirtual

when clicking a directory dependency label, a page with a table is shown. The heading for the second column mentions the destination file that is included.

Reimplemented from TranslatorAdapter_1_7_5.

Definition at line 1745 of file translator_fa.h.

1746 {
1747 return "Includes file in "+name;
1748 }

◆ trIncludingInheritedMembers()

DString TranslatorPersian::trIncludingInheritedMembers ( )
inlineoverridevirtual

this is the remainder of the sentence after the class name

Implements Translator.

Definition at line 168 of file translator_fa.h.

169 { return "شامل همه ی اعضای به ارث برده شده می باشد."; }

◆ trInheritedByList()

DString TranslatorPersian::trInheritedByList ( int numEntries)
inlineoverridevirtual

used in class documentation to produce a list of super classes, if class diagrams are disabled.

Implements Translator.

Definition at line 687 of file translator_fa.h.

688 {
689 return ".اين کلاس را به ارث برده است "+trWriteList(numEntries)+".";
690 }

References trWriteList().

◆ trInheritsList()

DString TranslatorPersian::trInheritsList ( int numEntries)
inlineoverridevirtual

used in class documentation to produce a list of base classes, if class diagrams are disabled.

Implements Translator.

Definition at line 679 of file translator_fa.h.

680 {
681 return ".را به ارث می برد "+trWriteList(numEntries)+".";
682 }

References trWriteList().

◆ trInitialValue()

DString TranslatorPersian::trInitialValue ( )
inlineoverridevirtual

Text shown before a multi-line variable/enum initialization

Implements Translator.

Definition at line 857 of file translator_fa.h.

858 {
859 return "مقدار اوليه :";
860 }

◆ trInvariant()

DString TranslatorPersian::trInvariant ( )
inlineoverridevirtual

Text for the \invariant command

Implements Translator.

Definition at line 852 of file translator_fa.h.

853 {
854 return "Invariant";
855 }

◆ trISOLang()

DString TranslatorPersian::trISOLang ( )
inlineoverridevirtual

Implements Translator.

Definition at line 99 of file translator_fa.h.

100 {
101 return "fa";
102 }

◆ trLegend()

DString TranslatorPersian::trLegend ( )
inlineoverridevirtual

text for the link to the legend page

Implements Translator.

Definition at line 1050 of file translator_fa.h.

1051 {
1052 return "راهنما";
1053 }

◆ trLegendDocs()

DString TranslatorPersian::trLegendDocs ( )
inlineoverridevirtual

page explaining how the dot graph's should be interpreted The A in the text below are to prevent link to classes called "A".

Implements Translator.

Definition at line 987 of file translator_fa.h.

988 {
989 return
990 "This page explains how to interpret the graphs that are generated "
991 "by doxygen.<p>\n"
992 "Consider the following example:\n"
993 "\\code\n"
994 "/*! Invisible class because of truncation */\n"
995 "class Invisible { };\n\n"
996 "/*! Truncated class, inheritance relation is hidden */\n"
997 "class Truncated : public Invisible { };\n\n"
998 "/* Class not documented with doxygen comments */\n"
999 "class Undocumented { };\n\n"
1000 "/*! Class that is inherited using public inheritance */\n"
1001 "class PublicBase : public Truncated { };\n\n"
1002 "/*! A template class */\n"
1003 "template<class T> class Templ { };\n\n"
1004 "/*! Class that is inherited using protected inheritance */\n"
1005 "class ProtectedBase { };\n\n"
1006 "/*! Class that is inherited using private inheritance */\n"
1007 "class PrivateBase { };\n\n"
1008 "/*! Class that is used by the Inherited class */\n"
1009 "class Used { };\n\n"
1010 "/*! Super class that inherits a number of other classes */\n"
1011 "class Inherited : public PublicBase,\n"
1012 " protected ProtectedBase,\n"
1013 " private PrivateBase,\n"
1014 " public Undocumented\n"
1015 " public Templ<int>\n"
1016 "{\n"
1017 " private:\n"
1018 " Used *m_usedClass;\n"
1019 "};\n"
1020 "\\endcode\n"
1021 "If the \\c MAX_DOT_GRAPH_HEIGHT tag in the configuration file "
1022 "is set to 240 this will result in the following graph:"
1023 "<p><center><img alt=\"\" src=\"graph_legend."+getDotImageExtension()+"\"></center>\n"
1024 "<p>\n"
1025 "The boxes in the above graph have the following meaning:\n"
1026 "<ul>\n"
1027 "<li>%A filled black box represents the struct or class for which the "
1028 "graph is generated.\n"
1029 "<li>%A box with a black border denotes a documented struct or class.\n"
1030 "<li>%A box with a gray border denotes an undocumented struct or class.\n"
1031 "<li>%A box with a red border denotes a documented struct or class for"
1032 "which not all inheritance/containment relations are shown. %A graph is "
1033 "truncated if it does not fit within the specified boundaries.\n"
1034 "</ul>\n"
1035 "The arrows have the following meaning:\n"
1036 "<ul>\n"
1037 "<li>%A dark blue arrow is used to visualize a public inheritance "
1038 "relation between two classes.\n"
1039 "<li>%A dark green arrow is used for protected inheritance.\n"
1040 "<li>%A dark red arrow is used for private inheritance.\n"
1041 "<li>%A purple dashed arrow is used if a class is contained or used "
1042 "by another class. The arrow is labeled with the variable(s) "
1043 "through which the pointed class or struct is accessible.\n"
1044 "<li>%A yellow dashed arrow denotes a relation between a template instance and "
1045 "the template class it was instantiated from. The arrow is labeled with "
1046 "the template parameters of the instance.\n"
1047 "</ul>\n";
1048 }
DString getDotImageExtension()
Definition util.cpp:6333

References getDotImageExtension().

◆ trLegendTitle()

DString TranslatorPersian::trLegendTitle ( )
inlineoverridevirtual

title of the graph legend page

Implements Translator.

Definition at line 980 of file translator_fa.h.

981 {
982 return "راهنمای نمودار";
983 }

◆ trListOfAllMembers()

DString TranslatorPersian::trListOfAllMembers ( )
inlineoverridevirtual

put in the class documentation

Implements Translator.

Definition at line 156 of file translator_fa.h.

157 { return "ليست تمام اعضاء "; }

◆ trLoading()

DString TranslatorPersian::trLoading ( )
inlineoverridevirtual

Loading message shown when loading search results

Implements Translator.

Definition at line 1705 of file translator_fa.h.

1706 {
1707 return "در حال بارگذاری...";
1708 }

◆ trMainPage()

DString TranslatorPersian::trMainPage ( )
inlineoverridevirtual

This is in the (quick) index as a link to the main page (index.html)

Implements Translator.

Definition at line 782 of file translator_fa.h.

783 { return "صفحه ی اصلی"; }

◆ trMember()

DString TranslatorPersian::trMember ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1245 of file translator_fa.h.

1246 {
1247 DString result((first_capital ? "عضو" : "عضو"));
1248 if (!singular) result+="ها";
1249 return result;
1250 }

◆ trMemberDataDocumentation()

DString TranslatorPersian::trMemberDataDocumentation ( )
inlineoverridevirtual

header that is put before the list of member attributes.

Implements Translator.

Definition at line 139 of file translator_fa.h.

140 {
141 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
142 {
143 return "Field مستندات";
144 }
145 else
146 {
147 return "مستندات متغيير های عضو";
148 }
149 }

References Config_getBool.

◆ trMemberEnumerationDocumentation()

DString TranslatorPersian::trMemberEnumerationDocumentation ( )
inlineoverridevirtual

header that is put before the list of enumerations.

Implements Translator.

Definition at line 131 of file translator_fa.h.

132 { return "های عضو Enumeration مستندات"; }

◆ trMemberFunctionDocumentation()

DString TranslatorPersian::trMemberFunctionDocumentation ( )
inlineoverridevirtual

header that is put before the list of member functions.

Implements Translator.

Definition at line 135 of file translator_fa.h.

136 { return "توضيحات توابع عضو"; }

◆ trMemberFunctionDocumentationFortran()

DString TranslatorPersian::trMemberFunctionDocumentationFortran ( )
inlineoverridevirtual

header that is put before the list of member subprograms (Fortran).

Implements Translator.

Definition at line 1528 of file translator_fa.h.

1529 { return "مستندات توابع عضو"; }

◆ trMemberList()

DString TranslatorPersian::trMemberList ( )
inlineoverridevirtual

used as the title of the "list of all members" page of a class

Implements Translator.

Definition at line 160 of file translator_fa.h.

161 { return "ليست اعضاء"; }

◆ trMemberTypedefDocumentation()

DString TranslatorPersian::trMemberTypedefDocumentation ( )
inlineoverridevirtual

header that is put before the list of typedefs.

Implements Translator.

Definition at line 127 of file translator_fa.h.

128 { return "مستندات تعریف گونه ها"; }

◆ trModule()

DString TranslatorPersian::trModule ( bool ,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1640 of file translator_fa.h.

1641 {
1642 DString result("ماژول");
1643 if (!singular) result+=" ها";
1644 return result;
1645 }

◆ trModuleDocumentation()

DString TranslatorPersian::trModuleDocumentation ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter containing the documentation of all groups.

Implements Translator.

Definition at line 388 of file translator_fa.h.

389 { return "مستندات ماژول"; }

◆ trModuleIndex()

DString TranslatorPersian::trModuleIndex ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the index of all groups.

Implements Translator.

Definition at line 355 of file translator_fa.h.

356 { return "فهرست ماژول ها"; }

◆ trModuleReference()

DString TranslatorPersian::trModuleReference ( const DString & namespaceName)
inlineoverridevirtual

used as the title of the HTML page of a module (Fortran)

Implements Translator.

Definition at line 1612 of file translator_fa.h.

1613 {
1614 DString result=namespaceName;
1615 result+=" Module Reference";
1616 return result;
1617 }

◆ trModules()

DString TranslatorPersian::trModules ( )
inlineoverridevirtual

This is put above each page as a link to the list of all groups of compounds or files (see the \group command).

Implements Translator.

Definition at line 198 of file translator_fa.h.

199 { return "Modules"; }

◆ trModulesDescription()

DString TranslatorPersian::trModulesDescription ( )
inlineoverridevirtual

This is an introduction to the page with the list of class/file groups

Implements Translator.

Definition at line 342 of file translator_fa.h.

343 { return "لیست تمام ماژول ها:"; }

◆ trModulesIndex()

DString TranslatorPersian::trModulesIndex ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the index of all modules (Fortran).

Implements Translator.

Definition at line 1633 of file translator_fa.h.

1634 { return "Modules Index"; }

◆ trModulesList()

DString TranslatorPersian::trModulesList ( )
inlineoverridevirtual

used as the title of page containing all the index of all modules (Fortran).

Implements Translator.

Definition at line 1580 of file translator_fa.h.

1581 { return "لیست ماژول ها"; }

◆ trModulesListDescription()

DString TranslatorPersian::trModulesListDescription ( bool )
inlineoverridevirtual

used as an introduction to the modules list (Fortran)

Implements Translator.

Definition at line 1584 of file translator_fa.h.

1585 {
1586 DString result="لیست ماژول ها به همراه توضیحات کوتاه";
1587 return result;
1588 }

◆ trModulesMemberDescription()

DString TranslatorPersian::trModulesMemberDescription ( bool )
inlineoverridevirtual

This is an introduction to the page with all modules members (Fortran)

Implements Translator.

Definition at line 1624 of file translator_fa.h.

1625 {
1626 DString result="لیست اعضاء ماژول ها به همراه مستندات ماژول مربوطه";
1627 return result;
1628 }

◆ trModulesMembers()

DString TranslatorPersian::trModulesMembers ( )
inlineoverridevirtual

This is put above each page as a link to all members of modules. (Fortran)

Implements Translator.

Definition at line 1620 of file translator_fa.h.

1621 { return "اعضاء ماژول"; }

◆ trMonth()

DString TranslatorPersian::trMonth ( int month,
bool ,
bool full )
inlineoverridevirtual

Implements Translator.

Definition at line 1787 of file translator_fa.h.

1788 {
1789 static const char *months_short[] = { "ژانويه", "فوريه", "مارس", "آوريل", "مه", "ژوئن", "ژوئيه", "اوت", "سپتامبر", "اُكتبر", "نوامبر", "دسامبر" };
1790 static const char *months_full[] = { "ژانويه", "فوريه", "مارس", "آوريل", "مه", "ژوئن", "ژوئيه", "اوت", "سپتامبر", "اُكتبر", "نوامبر", "دسامبر" };
1791 DString text = full? months_full[month-1] : months_short[month-1];
1792 return text;
1793 }

◆ trMore()

DString TranslatorPersian::trMore ( )
inlineoverridevirtual

this is the text of a link put after brief descriptions.

Implements Translator.

Definition at line 152 of file translator_fa.h.

153 { return "بيشتر..."; }

◆ trNamespace()

DString TranslatorPersian::trNamespace ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1212 of file translator_fa.h.

1213 {
1214 DString result((first_capital ? "فضای نام " : "فضای نام "));
1215 if (!singular) result+="ها";
1216 return result;
1217 }

◆ trNamespaceDocumentation()

DString TranslatorPersian::trNamespaceDocumentation ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter containing the documentation of all namespaces.

Implements Translator.

Definition at line 730 of file translator_fa.h.

731 { return "توضيحات فضای نام"; }

◆ trNamespaceIndex()

DString TranslatorPersian::trNamespaceIndex ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter with the index of all namespaces.

Implements Translator.

Definition at line 724 of file translator_fa.h.

725 { return "فهرست فضاهای نام"; }

◆ trNamespaceList()

DString TranslatorPersian::trNamespaceList ( )
inlineoverridevirtual

used as the title of page containing all the index of all namespaces.

Implements Translator.

Definition at line 561 of file translator_fa.h.

562 { return "ليست فضاهای نام"; }

◆ trNamespaceListDescription()

DString TranslatorPersian::trNamespaceListDescription ( bool extractAll)
inlineoverridevirtual

used as an introduction to the namespace list

Implements Translator.

Definition at line 565 of file translator_fa.h.

566 {
567 DString result="در ذيل ليستی از همه ی فضاهای نام ";
568 if (!extractAll) result+="(مستند سازی شده) ";
569 result+="به همراه توضيح کوتاه آنها مشاهده می کنيد :";
570 return result;
571 }

◆ trNamespaceMemberDescription()

DString TranslatorPersian::trNamespaceMemberDescription ( bool extractAll)
inlineoverridevirtual

This is an introduction to the page with all namespace members

Implements Translator.

Definition at line 713 of file translator_fa.h.

714 {
715 DString result="ليست همه اعضای فضای نام ";
716 if (!extractAll) result+="(مستند شده) ";
717 result+=" با ارتباطشان با";
718 result+="فضاهای نامی که به آن مربوط اند را مشاهده ميکنيد :";
719 return result;
720 }

◆ trNamespaceMembers()

DString TranslatorPersian::trNamespaceMembers ( )
inlineoverridevirtual

This is put above each page as a link to all members of namespaces.

Implements Translator.

Definition at line 709 of file translator_fa.h.

710 { return "اعضای فضاهای نام"; }

◆ trNamespaceReference()

DString TranslatorPersian::trNamespaceReference ( const DString & namespaceName)
inlineoverridevirtual

used as the title of the HTML page of a namespace

Implements Translator.

Definition at line 624 of file translator_fa.h.

625 {
626 DString result=namespaceName;
627 result+=" مرجع فضای نام";
628 return result;
629 }

◆ trNamespaces()

DString TranslatorPersian::trNamespaces ( )
inlineoverridevirtual

This is used in the documentation before the list of all namespaces in a file.

Implements Translator.

Definition at line 740 of file translator_fa.h.

741 { return "فضاهای نام"; }

◆ trNoMatches()

DString TranslatorPersian::trNoMatches ( )
inlineoverridevirtual

Text shown when no search results are found

Implements Translator.

Definition at line 1723 of file translator_fa.h.

1724 {
1725 return "یافت نشد";
1726 }

◆ trNote()

DString TranslatorPersian::trNote ( )
inlineoverridevirtual

Implements Translator.

Definition at line 887 of file translator_fa.h.

888 {
889 return "نکته";
890 }

◆ trOverloadText()

DString TranslatorPersian::trOverloadText ( )
inlineoverridevirtual

This text is added to the documentation when the \overload command is used for a overloaded function.

Implements Translator.

Definition at line 1507 of file translator_fa.h.

1508 {
1509 return "This is an overloaded member function, "
1510 "provided for convenience. It differs from the above "
1511 "function only in what argument(s) it accepts.";
1512 }

◆ trPackage()

DString TranslatorPersian::trPackage ( const DString & name)
inlineoverridevirtual

Used as the title of a Java package

Implements Translator.

Definition at line 1102 of file translator_fa.h.

1103 {
1104 return "Package "+name;
1105 }

◆ trPackageAttribs()

DString TranslatorPersian::trPackageAttribs ( )
inlineoverridevirtual

Used as a heading for a list of Java class variables with package scope.

Implements Translator.

Definition at line 1379 of file translator_fa.h.

1380 {
1381 return "خواص بسته ها";
1382 }

◆ trPackageFunctions()

DString TranslatorPersian::trPackageFunctions ( )
inlineoverridevirtual

Used as a heading for a list of Java class functions with package scope.

Implements Translator.

Definition at line 1361 of file translator_fa.h.

1362 {
1363 return "توابع بسته ها";
1364 }

◆ trPackageListDescription()

DString TranslatorPersian::trPackageListDescription ( )
inlineoverridevirtual

The description of the package index page

Implements Translator.

Definition at line 1107 of file translator_fa.h.

1108 {
1109 return "لیست بسته ها به همراه توضیح مختر در صورت وجود :";
1110 }

◆ trPackageMembers()

DString TranslatorPersian::trPackageMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 1365 of file translator_fa.h.

1366 {
1367 return "عضوها بسته ها";
1368 }

◆ trPackages()

DString TranslatorPersian::trPackages ( )
inlineoverridevirtual

The link name in the Quick links header for each page

Implements Translator.

Definition at line 1112 of file translator_fa.h.

1113 {
1114 return "بسته ها";
1115 }

◆ trPackageTypes()

DString TranslatorPersian::trPackageTypes ( )
inlineoverridevirtual

Used as a heading for a list of Java class types with package scope.

Implements Translator.

Definition at line 1354 of file translator_fa.h.

1355 {
1356 return "انواع بسته ها";
1357 }

◆ trPage()

DString TranslatorPersian::trPage ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1234 of file translator_fa.h.

1235 {
1236 DString result((first_capital ? "صفحه" : "صفحه"));
1237 if (!singular) result+=" ها ";
1238 return result;
1239 }

◆ trPageAbbreviation()

DString TranslatorPersian::trPageAbbreviation ( )
inlineoverridevirtual

This is used in references to page that are put in the LaTeX documentation. It should be an abbreviation of the word page.

Implements Translator.

Definition at line 788 of file translator_fa.h.

789 { return "ص."; }

◆ trPageIndex()

DString TranslatorPersian::trPageIndex ( )
inlineoverridevirtual

Implements Translator.

Definition at line 878 of file translator_fa.h.

879 {
880 return "فهرست صفحات";
881 }

◆ trParameters()

DString TranslatorPersian::trParameters ( )
inlineoverridevirtual

this text is generated when the \param command is used.

Implements Translator.

Definition at line 545 of file translator_fa.h.

546 { return "پارامترها"; }

◆ trPostcondition()

DString TranslatorPersian::trPostcondition ( )
inlineoverridevirtual

Text for the \post command

Implements Translator.

Definition at line 847 of file translator_fa.h.

848 {
849 return "پس شرط";
850 }

◆ trPrecondition()

DString TranslatorPersian::trPrecondition ( )
inlineoverridevirtual

Text for the \pre command

Implements Translator.

Definition at line 842 of file translator_fa.h.

843 {
844 return "پیش شرط";
845 }

◆ trPrivateAttribs()

DString TranslatorPersian::trPrivateAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 926 of file translator_fa.h.

927 {
928 return "خواص (متغييرهای) خصوصی";
929 }

◆ trPrivateMembers()

DString TranslatorPersian::trPrivateMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 645 of file translator_fa.h.

646 { return "توابع خصوصی عضو کلاس"; }

◆ trPrivateSlots()

DString TranslatorPersian::trPrivateSlots ( )
inlineoverridevirtual

Implements Translator.

Definition at line 647 of file translator_fa.h.

648 { return "های خصوصی Slot"; }

◆ trPrivateTypes()

DString TranslatorPersian::trPrivateTypes ( )
inlineoverridevirtual

Implements Translator.

Definition at line 922 of file translator_fa.h.

923 {
924 return "های خصوصی Type";
925 }

◆ trProperties()

DString TranslatorPersian::trProperties ( )
inlineoverridevirtual

Used as a section header for IDL properties

Implements Translator.

Definition at line 1075 of file translator_fa.h.

1076 {
1077 return "خاصیت ها";
1078 }

◆ trPropertyDocumentation()

DString TranslatorPersian::trPropertyDocumentation ( )
inlineoverridevirtual

Used as a section header for IDL property documentation

Implements Translator.

Definition at line 1080 of file translator_fa.h.

1081 {
1082 return "مستندات خاصیت";
1083 }

◆ trProtectedAttribs()

DString TranslatorPersian::trProtectedAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 914 of file translator_fa.h.

915 {
916 return "خواص (متغييرهای) حفاظت شده";
917 }

◆ trProtectedMembers()

DString TranslatorPersian::trProtectedMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 639 of file translator_fa.h.

640 { return "توابع خصوصی عضو کلاس"; }

◆ trProtectedSlots()

DString TranslatorPersian::trProtectedSlots ( )
inlineoverridevirtual

Implements Translator.

Definition at line 641 of file translator_fa.h.

642 { return "های محافظت شده Slot"; }

◆ trProtectedTypes()

DString TranslatorPersian::trProtectedTypes ( )
inlineoverridevirtual

Implements Translator.

Definition at line 910 of file translator_fa.h.

911 {
912 return "های حفاظت شده Type";
913 }

◆ trPublicAttribs()

DString TranslatorPersian::trPublicAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 895 of file translator_fa.h.

896 {
897 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
898 {
899 return "فضاهای داده ها";
900 }
901 else
902 {
903 return "خواص (متغييرهای) عمومی";
904 }
905 }

References Config_getBool.

◆ trPublicMembers()

DString TranslatorPersian::trPublicMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 631 of file translator_fa.h.

632 { return "توابع عمومی عضو کلاس"; }

◆ trPublicSlots()

DString TranslatorPersian::trPublicSlots ( )
inlineoverridevirtual

Implements Translator.

Definition at line 633 of file translator_fa.h.

634 { return "های عمومی Slot"; }

◆ trPublicTypes()

DString TranslatorPersian::trPublicTypes ( )
inlineoverridevirtual

Implements Translator.

Definition at line 891 of file translator_fa.h.

892 {
893 return "های عمومی Type";
894 }

◆ trReferencedBy()

DString TranslatorPersian::trReferencedBy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 954 of file translator_fa.h.

955 {
956 return " استفاده شده توسط ";
957 }

◆ trReferenceManual()

DString TranslatorPersian::trReferenceManual ( )
inlineoverridevirtual

This is used in LaTeX as the title of the document

Implements Translator.

Definition at line 417 of file translator_fa.h.

418 { return "راهنمای مرجع"; }

◆ trReferences()

DString TranslatorPersian::trReferences ( )
inlineoverridevirtual

This text is put before the list of members referenced by a member

Implements Translator.

Definition at line 1282 of file translator_fa.h.

1283 {
1284 return "را استفاده ميکند ";
1285 }

◆ trReimplementedFromList()

DString TranslatorPersian::trReimplementedFromList ( int numEntries)
inlineoverridevirtual

used in member documentation blocks to produce a list of members that are hidden by this one.

Implements Translator.

Definition at line 695 of file translator_fa.h.

696 {
697 return "Reimplemented from "+trWriteList(numEntries)+".";
698 }

References trWriteList().

◆ trReimplementedInList()

DString TranslatorPersian::trReimplementedInList ( int numEntries)
inlineoverridevirtual

used in member documentation blocks to produce a list of all member that overwrite the implementation of this member.

Implements Translator.

Definition at line 703 of file translator_fa.h.

704 {
705 return "تعریف شده است "+trWriteList(numEntries)+"دوباره در ";
706 }

References trWriteList().

◆ trRelatedFunctionDocumentation()

DString TranslatorPersian::trRelatedFunctionDocumentation ( )
inlineoverridevirtual

used in the class documentation as a header before the list of all related classes

Implements Translator.

Definition at line 586 of file translator_fa.h.

587 { return "مستندات توابع مربوط و دوست"; }

◆ trRelatedFunctions()

DString TranslatorPersian::trRelatedFunctions ( )
inlineoverridevirtual

used in the compound documentation before a list of related functions.

Implements Translator.

Definition at line 111 of file translator_fa.h.

112 { return "توابع مربوط"; }

◆ trRelatedPages()

DString TranslatorPersian::trRelatedPages ( )
inlineoverridevirtual

This is put above each page as a link to all related pages.

Implements Translator.

Definition at line 249 of file translator_fa.h.

250 { return "صفحات مربوط"; }

◆ trRelatedPagesDescription()

DString TranslatorPersian::trRelatedPagesDescription ( )
inlineoverridevirtual

This is an introduction to the page with the list of related pages

Implements Translator.

Definition at line 338 of file translator_fa.h.

339 { return "لیست تمام صفحات و مستندات مربوطه :"; }

◆ trRelatedSubscript()

DString TranslatorPersian::trRelatedSubscript ( )
inlineoverridevirtual

subscript for the related functions.

Implements Translator.

Definition at line 115 of file translator_fa.h.

116 { return "(لازم به ذکر است که اينها توابع عضو نيستند)"; }

◆ trRemarks()

DString TranslatorPersian::trRemarks ( )
inlineoverridevirtual

Implements Translator.

Definition at line 958 of file translator_fa.h.

959 {
960 return "ملاحظات";
961 }

◆ trReturns()

DString TranslatorPersian::trReturns ( )
inlineoverridevirtual

this text is generated when the \return command is used.

Implements Translator.

Definition at line 537 of file translator_fa.h.

538 { return "خروجی"; }

◆ trReturnValues()

DString TranslatorPersian::trReturnValues ( )
inlineoverridevirtual

This is used as the heading text for the retval command.

Implements Translator.

Definition at line 777 of file translator_fa.h.

778 { return "مقادير بازگشتی"; }

◆ trRTFansicp()

DString TranslatorPersian::trRTFansicp ( )
inlineoverridevirtual

Used as ansicpg for RTF file

The following table shows the correlation of Charset name, Charset Value and

Codepage number:
Charset Name       Charset Value(hex)  Codepage number
------------------------------------------------------
DEFAULT_CHARSET           1 (x01)
SYMBOL_CHARSET            2 (x02)
OEM_CHARSET             255 (xFF)
ANSI_CHARSET              0 (x00)            1252
RUSSIAN_CHARSET         204 (xCC)            1251
EE_CHARSET              238 (xEE)            1250
GREEK_CHARSET           161 (xA1)            1253
TURKISH_CHARSET         162 (xA2)            1254
BALTIC_CHARSET          186 (xBA)            1257
HEBREW_CHARSET          177 (xB1)            1255
ARABIC _CHARSET         178 (xB2)            1256
SHIFTJIS_CHARSET        128 (x80)             932
HANGEUL_CHARSET         129 (x81)             949
GB2313_CHARSET          134 (x86)             936
CHINESEBIG5_CHARSET     136 (x88)             950

Implements Translator.

Definition at line 1166 of file translator_fa.h.

1167 {
1168 return "1256";
1169 }

◆ trRTFCharSet()

DString TranslatorPersian::trRTFCharSet ( )
inlineoverridevirtual

Used as ansicpg for RTF fcharset

See also
trRTFansicp() for a table of possible values.

Implements Translator.

Definition at line 1175 of file translator_fa.h.

1176 {
1177 return "178";
1178 }

◆ trRTFGeneralIndex()

DString TranslatorPersian::trRTFGeneralIndex ( )
inlineoverridevirtual

Used as header RTF general index

Implements Translator.

Definition at line 1181 of file translator_fa.h.

1182 {
1183 return "فهرست";
1184 }

◆ trRTFTableOfContents()

DString TranslatorPersian::trRTFTableOfContents ( )
inlineoverridevirtual

used in RTF documentation as a heading for the Table of Contents.

Implements Translator.

Definition at line 1314 of file translator_fa.h.

1315 {
1316 return "فهرست";
1317 }

◆ trSearch()

DString TranslatorPersian::trSearch ( )
inlineoverridevirtual

This is put above each page as a link to the search engine.

Implements Translator.

Definition at line 257 of file translator_fa.h.

258 { return "جستجو"; }

◆ trSearching()

DString TranslatorPersian::trSearching ( )
inlineoverridevirtual

Message shown while searching

Implements Translator.

Definition at line 1717 of file translator_fa.h.

1718 {
1719 return "در حال جستجو...";
1720 }

◆ trSearchMatches()

DString TranslatorPersian::trSearchMatches ( )
inlineoverridevirtual

This string is put before the list of matched words, for each search result. What follows is the list of words that matched the query.

Implements Translator.

Definition at line 1446 of file translator_fa.h.

1447 {
1448 return "Matches:";
1449 }

◆ trSearchResults()

DString TranslatorPersian::trSearchResults ( int numDocuments)
inlineoverridevirtual

This string is put just before listing the search results. The text can be different depending on the number of documents found. Inside the text you can put the special marker $num to insert the number representing the actual number of search results. The numDocuments parameter can be either 0, 1 or 2, where the value 2 represents 2 or more matches. HTML markup is allowed inside the returned string.

Implements Translator.

Definition at line 1427 of file translator_fa.h.

1428 {
1429 if (numDocuments==0)
1430 {
1431 return "متاسفانه هیچ صفحه ای برای جستجو ی شما یافت نشد.";
1432 }
1433 else if (numDocuments==1)
1434 {
1435 return "یک سند برای این مورد یافت شد.";
1436 }
1437 else
1438 {
1439 return "Found <b>$num</b> documents matching your query. "
1440 "Showing best matches first.";
1441 }
1442 }

◆ trSearchResultsTitle()

DString TranslatorPersian::trSearchResultsTitle ( )
inlineoverridevirtual

This string is used as the title for the page listing the search results.

Implements Translator.

Definition at line 1415 of file translator_fa.h.

1416 {
1417 return "نتايج جستجو";
1418 }

◆ trSeeAlso()

DString TranslatorPersian::trSeeAlso ( )
inlineoverridevirtual

this text is generated when the \sa command is used.

Implements Translator.

Definition at line 541 of file translator_fa.h.

542 { return "See also"; }

◆ trSignals()

DString TranslatorPersian::trSignals ( )
inlineoverridevirtual

Implements Translator.

Definition at line 635 of file translator_fa.h.

636 { return "سيگنال ها"; }

◆ trSince()

DString TranslatorPersian::trSince ( )
inlineoverridevirtual

Implements Translator.

Definition at line 970 of file translator_fa.h.

971 {
972 return "از";
973 }

◆ trSourceFile()

DString TranslatorPersian::trSourceFile ( const DString & filename)
inlineoverridevirtual

This is used in HTML as the title of page with source code for file filename

Implements Translator.

Definition at line 1457 of file translator_fa.h.

1458 {
1459 return filename + " کد و پرونده منبع";
1460 }

◆ trStaticPackageAttribs()

DString TranslatorPersian::trStaticPackageAttribs ( )
inlineoverridevirtual

Used as a heading for a list of static Java class variables with package scope.

Implements Translator.

Definition at line 1386 of file translator_fa.h.

1387 {
1388 return "Static Package Attributes";
1389 }

◆ trStaticPackageFunctions()

DString TranslatorPersian::trStaticPackageFunctions ( )
inlineoverridevirtual

Used as a heading for a list of static Java class functions with package scope.

Implements Translator.

Definition at line 1372 of file translator_fa.h.

1373 {
1374 return "Static Package Functions";
1375 }

◆ trStaticPrivateAttribs()

DString TranslatorPersian::trStaticPrivateAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 930 of file translator_fa.h.

931 {
932 return "خواص (متغييرهای) خصوصی ثابت";
933 }

◆ trStaticPrivateMembers()

DString TranslatorPersian::trStaticPrivateMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 649 of file translator_fa.h.

650 { return "توابع خصوصی ثابت عضو کلاس"; }

◆ trStaticProtectedAttribs()

DString TranslatorPersian::trStaticProtectedAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 918 of file translator_fa.h.

919 {
920 return "خواص (متغييرهای) حفاظت شده ثابت";
921 }

◆ trStaticProtectedMembers()

DString TranslatorPersian::trStaticProtectedMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 643 of file translator_fa.h.

644 { return "توابع ثابت محافظت شده عضو کلاس"; }

◆ trStaticPublicAttribs()

DString TranslatorPersian::trStaticPublicAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 906 of file translator_fa.h.

907 {
908 return "خواص (متغييرهای) عمومی ثابت";
909 }

◆ trStaticPublicMembers()

DString TranslatorPersian::trStaticPublicMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 637 of file translator_fa.h.

638 { return "توابع ثابت عمومی عضو کلاس"; }

◆ trSubprogram()

DString TranslatorPersian::trSubprogram ( bool ,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1681 of file translator_fa.h.

1682 {
1683 DString result("زیربرنامه");
1684 if (!singular) result+=" ها ";
1685 return result;
1686 }

◆ trSubprogramDocumentation()

DString TranslatorPersian::trSubprogramDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace before the list of documentation blocks for subprograms (Fortran)

Implements Translator.

Definition at line 1570 of file translator_fa.h.

1571 { return "مستندات توابع و زیربرنامه ها"; }

◆ trSubprograms()

DString TranslatorPersian::trSubprograms ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of (global) subprograms (Fortran).

Implements Translator.

Definition at line 1564 of file translator_fa.h.

1565 { return "توابع و زیربرنامه ها"; }

◆ trTest()

DString TranslatorPersian::trTest ( )
inlineoverridevirtual

Used as a marker that is put before a test item

Implements Translator.

Definition at line 1060 of file translator_fa.h.

1061 {
1062 return "تست";
1063 }

◆ trTestList()

DString TranslatorPersian::trTestList ( )
inlineoverridevirtual

Used as the header of the test list

Implements Translator.

Definition at line 1065 of file translator_fa.h.

1066 {
1067 return "Test List";
1068 }

◆ trThisIsTheListOfAllMembers()

DString TranslatorPersian::trThisIsTheListOfAllMembers ( )
inlineoverridevirtual

this is the first part of a sentence that is followed by a class name

Implements Translator.

Definition at line 164 of file translator_fa.h.

165 { return "اين ليستی کامل از همه اعضای"; }

◆ trTodo()

DString TranslatorPersian::trTodo ( )
inlineoverridevirtual

Used as a marker that is put before a \todo item

Implements Translator.

Definition at line 940 of file translator_fa.h.

941 {
942 return "برای انجام";
943 }

◆ trTodoList()

DString TranslatorPersian::trTodoList ( )
inlineoverridevirtual

Used as the header of the todo list

Implements Translator.

Definition at line 945 of file translator_fa.h.

946 {
947 return "ليست کارهاي آينده";
948 }

◆ trType()

DString TranslatorPersian::trType ( bool first_capital,
bool singular )
inlineoverridevirtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1673 of file translator_fa.h.

1674 {
1675 return createNoun(first_capital, singular, "type", "s");
1676 }
DString createNoun(bool first_capital, bool singular, const DString &base, const DString &plurSuffix, const DString &singSuffix="")
Definition translator.h:801

References Translator::createNoun().

◆ trTypeConstraints()

DString TranslatorPersian::trTypeConstraints ( )
inlineoverridevirtual

C# Type Constraint list

Implements Translator.

Definition at line 1689 of file translator_fa.h.

1690 {
1691 return "Type Constraints";
1692 }

◆ trTypedefDocumentation()

DString TranslatorPersian::trTypedefDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace before the list of documentation blocks for typedefs

Implements Translator.

Definition at line 465 of file translator_fa.h.

466 { return "Typedef"; }

◆ trTypedefs()

DString TranslatorPersian::trTypedefs ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of typedefs

Implements Translator.

Definition at line 429 of file translator_fa.h.

430 { return "تعریف گونه ها"; }

◆ trTypeDocumentation()

DString TranslatorPersian::trTypeDocumentation ( )
inlineoverridevirtual

This is used in LaTeX as the title of the chapter containing the documentation of all data types (Fortran).

Implements Translator.

Definition at line 1558 of file translator_fa.h.

1559 { return "Data Type Documentation"; }

◆ trVariableDocumentation()

DString TranslatorPersian::trVariableDocumentation ( )
inlineoverridevirtual

This is used in the documentation of a file/namespace before the list of documentation blocks for variables

Implements Translator.

Definition at line 489 of file translator_fa.h.

490 { return "توضيح متغير"; }

◆ trVariables()

DString TranslatorPersian::trVariables ( )
inlineoverridevirtual

This is used in the documentation of a file as a header before the list of (global) variables

Implements Translator.

Definition at line 447 of file translator_fa.h.

448 { return "متغيير ها"; }

◆ trVersion()

DString TranslatorPersian::trVersion ( )
inlineoverridevirtual

this text is generated when the \version command is used.

Implements Translator.

Definition at line 529 of file translator_fa.h.

530 { return "نسخه"; }

◆ trWarning()

DString TranslatorPersian::trWarning ( )
inlineoverridevirtual

this text is generated when the \warning command is used.

Implements Translator.

Definition at line 525 of file translator_fa.h.

526 { return "اخطار"; }

◆ trWriteList()

DString TranslatorPersian::trWriteList ( int numEntries)
inlineoverridevirtual

this function is used to produce a comma-separated list of items. use generateMarker(i) to indicate where item i should be put.

Implements Translator.

Definition at line 655 of file translator_fa.h.

656 {
657 DString result;
658 // the inherits list contain `numEntries' classes
659 for (int i=0;i<numEntries;i++)
660 {
661 // use generateMarker to generate placeholders for the class links!
662 result+=generateMarker(i); // generate marker for entry i in the list
663 // (order is left to right)
664
665 if (i!=numEntries-1) // not the last entry, so we need a separator
666 {
667 if (i<numEntries-2) // not the fore last entry
668 result+=", ";
669 else // the fore last entry
670 result+=" و ";
671 }
672 }
673 return result;
674 }
DString generateMarker(int id)
Definition util.cpp:279

References generateMarker().

Referenced by trImplementedFromList(), trImplementedInList(), trInheritedByList(), trInheritsList(), trReimplementedFromList(), and trReimplementedInList().


The documentation for this class was generated from the following file: