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 40 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 44 of file translator_fa.h.

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

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 101 of file translator_fa.h.

102 {
103 return "0x429 Persian (Iran)";
104 }

◆ 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 69 of file translator_fa.h.

70 { return "persian"; }

◆ latexCommandName()

DString TranslatorPersian::latexCommandName ( )
inlineoverridevirtual

Set the name to be used as latex command.

Reimplemented from Translator.

Definition at line 91 of file translator_fa.h.

92 {
93 return p_latexCommandName("xelatex");
94 }
DString p_latexCommandName(const DString &latexCmd)
Definition translator.h:786

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 86 of file translator_fa.h.

87 {
88 return "";
89 }

◆ 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 1395 of file translator_fa.h.

1396 {
1397 return "همه";
1398 }

◆ trAttention()

DString TranslatorPersian::trAttention ( )
inlineoverridevirtual

Implements Translator.

Definition at line 959 of file translator_fa.h.

960 {
961 return "توجه";
962 }

◆ 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 1266 of file translator_fa.h.

1267 {
1268 DString result((first_capital ? "Author" : "author"));
1269 if (!singular) result+="s";
1270 return result;
1271 }

◆ trBug()

DString TranslatorPersian::trBug ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1124 of file translator_fa.h.

1125 {
1126 return "اشکال";
1127 }

◆ trBugList()

DString TranslatorPersian::trBugList ( )
inlineoverridevirtual

Used as the header of the bug list

Implements Translator.

Definition at line 1129 of file translator_fa.h.

1130 {
1131 return "ليست اشکالات";
1132 }

◆ trCallerGraph()

DString TranslatorPersian::trCallerGraph ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1516 of file translator_fa.h.

1517 {
1518 return "نمودار صدا زننده های این تابع:";
1519 }

◆ trCallGraph()

DString TranslatorPersian::trCallGraph ( )
inlineoverridevirtual

Put in front of the call graph for a function.

Implements Translator.

Definition at line 1400 of file translator_fa.h.

1401 {
1402 return "نمودار صدا زدن برای این تابع :";
1403 }

◆ 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 1187 of file translator_fa.h.

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

◆ trClassDiagram()

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

this text is put before a class diagram

Implements Translator.

Definition at line 516 of file translator_fa.h.

517 {
518 return ""+clName+" نمودار وراثت برای :";
519 }

◆ 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 391 of file translator_fa.h.

392 {
393 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
394 {
395 return "مستندات ساختار داده ها";
396 }
397 else if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
398 {
400 }
401 else
402 {
403 return "مستندات کلاس ها";
404 }
405 }
DString trDesignUnitDocumentation() override
#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 1087 of file translator_fa.h.

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

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 199 of file translator_fa.h.

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

◆ trClassHierarchyDescription()

DString TranslatorPersian::trClassHierarchyDescription ( )
inlineoverridevirtual

This is an introduction to the class hierarchy.

Implements Translator.

Definition at line 258 of file translator_fa.h.

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

◆ trCode()

DString TranslatorPersian::trCode ( )
inlineoverridevirtual

Text used the source code in the file index

Implements Translator.

Definition at line 859 of file translator_fa.h.

860 {
861 return "کد";
862 }

◆ trCollaborationDiagram()

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

this text is put before a collaboration diagram

Implements Translator.

Definition at line 814 of file translator_fa.h.

815 {
816 return "Collaboration diagram for "+clName+":";
817 }

◆ 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 364 of file translator_fa.h.

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

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 1549 of file translator_fa.h.

1550 { 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 203 of file translator_fa.h.

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

References Config_getBool.

◆ trCompoundListDescription()

DString TranslatorPersian::trCompoundListDescription ( )
inlineoverridevirtual

This is an introduction to the annotated compound list.

Implements Translator.

Definition at line 272 of file translator_fa.h.

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

References Config_getBool.

◆ trCompoundListDescriptionFortran()

DString TranslatorPersian::trCompoundListDescriptionFortran ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1537 of file translator_fa.h.

1538 { 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 1529 of file translator_fa.h.

1530 { 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 220 of file translator_fa.h.

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

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 286 of file translator_fa.h.

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

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 1541 of file translator_fa.h.

1542 {
1543 return "توضیحات اعضا ساختارها به همراه مستندات ساختار داده ی مربوطه";
1544 }

◆ 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 1533 of file translator_fa.h.

1534 { 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 591 of file translator_fa.h.

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

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 1588 of file translator_fa.h.

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

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 492 of file translator_fa.h.

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

References Config_getBool.

◆ trConstructorDocumentation()

DString TranslatorPersian::trConstructorDocumentation ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 824 of file translator_fa.h.

825 {
826 return "مستندات توباع آغازین و پایانی";
827 }

◆ 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 1573 of file translator_fa.h.

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

◆ trDate()

DString TranslatorPersian::trDate ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 530 of file translator_fa.h.

531 { 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 1757 of file translator_fa.h.

1760 {
1761 static const char *days[] = { "دوشنبه","سه‌شنبه","چهارشنبه","پنجشنبه","جمعه","شنبه","یکشنبه" };
1762 static const char *months[] = { "ژانویه","فوریه","مارس","آوریل","می","جون","جولای","آگوست","سپتامبر","اکتبر","نوامبر","دسامبر" };
1763 DString sdate;
1764 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Date)
1765 {
1766 sdate.sprintf("%s %d %s %d",days[dayOfWeek-1],day,months[month-1],year);
1767 }
1768 if (includeTime == DateTimeType::DateTime) sdate += " ";
1769 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Time)
1770 {
1771 DString stime;
1772 stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);
1773 sdate+=stime;
1774 }
1775 return convertDigitsToFarsi(sdate);
1776 }
DString & sprintf(const char *format,...)
Definition dstring.cpp:34
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 1777 of file translator_fa.h.

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

◆ trDayPeriod()

DString TranslatorPersian::trDayPeriod ( bool period)
inlineoverridevirtual

Reimplemented from TranslatorAdapter_1_7_5.

Definition at line 1791 of file translator_fa.h.

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

◆ trDefinedAtLineInSourceFile()

DString TranslatorPersian::trDefinedAtLineInSourceFile ( )
inlineoverridevirtual

Implements Translator.

Definition at line 791 of file translator_fa.h.

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

◆ trDefinedIn()

DString TranslatorPersian::trDefinedIn ( )
inlineoverridevirtual

put after an undocumented member in the list of all members

Implements Translator.

Definition at line 187 of file translator_fa.h.

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

◆ trDefinedInSourceFile()

DString TranslatorPersian::trDefinedInSourceFile ( )
inlineoverridevirtual

Implements Translator.

Definition at line 795 of file translator_fa.h.

796 {
797 return ".در فايل @0 تعريف شده است";
798 }

◆ 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 456 of file translator_fa.h.

457 { 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 420 of file translator_fa.h.

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

◆ trDefineValue()

DString TranslatorPersian::trDefineValue ( )
inlineoverridevirtual

Text shown before a multi-line define

Implements Translator.

Definition at line 1114 of file translator_fa.h.

1115 {
1116 return "مقدار:";
1117 }

◆ trDeprecated()

DString TranslatorPersian::trDeprecated ( )
inlineoverridevirtual

Implements Translator.

Definition at line 804 of file translator_fa.h.

805 {
806 return "منسوخ شده";
807 }

◆ trDeprecatedList()

DString TranslatorPersian::trDeprecatedList ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1323 of file translator_fa.h.

1324 {
1325 return "لیست آیتم های از رده خارج";
1326 }

◆ trDetailedDescription()

DString TranslatorPersian::trDetailedDescription ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 116 of file translator_fa.h.

117 { 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 120 of file translator_fa.h.

121 { 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 1490 of file translator_fa.h.

1491 {
1492 DString result("شاخه");
1493 if (singular) result+=" ها "+result;
1494 return result;
1495 }

◆ 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 1472 of file translator_fa.h.

1473 { 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 1478 of file translator_fa.h.

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

◆ trDirIndex()

DString TranslatorPersian::trDirIndex ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1466 of file translator_fa.h.

1467 { 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 1484 of file translator_fa.h.

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

◆ trDirRelation()

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

directory relation for name

Implements Translator.

Definition at line 1696 of file translator_fa.h.

1697 {
1698 return name + " Relation";
1699 }

◆ trDocumentation()

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

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

Implements Translator.

Definition at line 346 of file translator_fa.h.

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

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 432 of file translator_fa.h.

433 { 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 468 of file translator_fa.h.

469 { 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 474 of file translator_fa.h.

475 { 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 450 of file translator_fa.h.

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

◆ trEnumName()

DString TranslatorPersian::trEnumName ( )
inlineoverridevirtual

put after an enum name in the list of all members

Implements Translator.

Definition at line 179 of file translator_fa.h.

180 { return "enum نام"; }

◆ trEnumValue()

DString TranslatorPersian::trEnumValue ( )
inlineoverridevirtual

put after an enum value in the list of all members

Implements Translator.

Definition at line 183 of file translator_fa.h.

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

◆ trEventDocumentation()

DString TranslatorPersian::trEventDocumentation ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1340 of file translator_fa.h.

1341 {
1342 return "مستندات رویداد";
1343 }

◆ 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 1335 of file translator_fa.h.

1336 {
1337 return "رویداد ها";
1338 }

◆ trExamples()

DString TranslatorPersian::trExamples ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 250 of file translator_fa.h.

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

◆ trExamplesDescription()

DString TranslatorPersian::trExamplesDescription ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 331 of file translator_fa.h.

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

◆ trExceptions()

DString TranslatorPersian::trExceptions ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 546 of file translator_fa.h.

547 { 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 1198 of file translator_fa.h.

1199 {
1200 DString result("پرونده");
1201 if (!singular) result=result+" ها";
1202 return result;
1203 }

◆ 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 410 of file translator_fa.h.

411 { 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 1733 of file translator_fa.h.

1734 {
1735 return "پرونده ای در "+name;
1736 }

◆ 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 379 of file translator_fa.h.

380 { 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 216 of file translator_fa.h.

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

◆ trFileListDescription()

DString TranslatorPersian::trFileListDescription ( bool extractAll)
inlineoverridevirtual

This is an introduction to the list with all files.

Implements Translator.

Definition at line 263 of file translator_fa.h.

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

◆ trFileMembers()

DString TranslatorPersian::trFileMembers ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 233 of file translator_fa.h.

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

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 320 of file translator_fa.h.

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

◆ trFileReference()

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

used as the title of the HTML page of a file

Implements Translator.

Definition at line 613 of file translator_fa.h.

614 {
615 DString result=fileName;
616 result+=" مرجع پرونده";
617 return result;
618 }

◆ 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 573 of file translator_fa.h.

574 { 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 480 of file translator_fa.h.

481 { 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 438 of file translator_fa.h.

439 { 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 507 of file translator_fa.h.

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

References 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 171 of file translator_fa.h.

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

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 550 of file translator_fa.h.

551 { 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 747 of file translator_fa.h.

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

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 1646 of file translator_fa.h.

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

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 1253 of file translator_fa.h.

1254 {
1255 DString result((first_capital ? "Global" : "global"));
1256 if (!singular) result+="s";
1257 return result;
1258 }

◆ trGlobalNamespace()

DString TranslatorPersian::trGlobalNamespace ( )
inlineoverridevirtual

Label used for search results in the global namespace

Implements Translator.

Definition at line 1708 of file translator_fa.h.

1709 {
1710 return "فضای نام جهانی";
1711 }

◆ trGotoDocumentation()

DString TranslatorPersian::trGotoDocumentation ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 834 of file translator_fa.h.

835 {
836 return "توضيحات اين پرونده.";
837 }

◆ trGotoGraphicalHierarchy()

DString TranslatorPersian::trGotoGraphicalHierarchy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 867 of file translator_fa.h.

868 {
869 return "نمایش نمودار درختی گرافیکی کلاس";
870 }

◆ trGotoSourceCode()

DString TranslatorPersian::trGotoSourceCode ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 829 of file translator_fa.h.

830 {
831 return "کد منبع اين پرونده.";
832 }

◆ trGotoTextualHierarchy()

DString TranslatorPersian::trGotoTextualHierarchy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 871 of file translator_fa.h.

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

◆ trGraphicalHierarchy()

DString TranslatorPersian::trGraphicalHierarchy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 863 of file translator_fa.h.

864 {
865 return "سلسله مراتب گرافيکی کلاس";
866 }

◆ 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 1220 of file translator_fa.h.

1221 {
1222 DString result((first_capital ? "Group" : "group"));
1223 if (!singular) result+="s";
1224 return result;
1225 }

◆ 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 358 of file translator_fa.h.

359 { 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 1291 of file translator_fa.h.

1292 {
1293 return "را تکميل می کند "+trWriteList(numEntries)+".";
1294 }
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 1299 of file translator_fa.h.

1300 {
1301 return ".تکميل شده است "+trWriteList(numEntries)+" در";
1302 }

References trWriteList().

◆ trInclByDepGraph()

DString TranslatorPersian::trInclByDepGraph ( )
inlineoverridevirtual

Implements Translator.

Definition at line 963 of file translator_fa.h.

964 {
965 return "این نمودار فایل هایی را که این فایل را به طور مستقیم یا غیر مستقیم استفاده کرده اند نشان می دهد";
966 }

◆ trInclDepGraph()

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

this text is put before an include dependency graph

Implements Translator.

Definition at line 819 of file translator_fa.h.

820 {
821 return "نمودار شامل شدن ها برای "+fName+":";
822 }

◆ 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 1742 of file translator_fa.h.

1743 {
1744 return "Includes file in "+name;
1745 }

◆ trIncludingInheritedMembers()

DString TranslatorPersian::trIncludingInheritedMembers ( )
inlineoverridevirtual

this is the remainder of the sentence after the class name

Implements Translator.

Definition at line 165 of file translator_fa.h.

166 { 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 684 of file translator_fa.h.

685 {
686 return ".اين کلاس را به ارث برده است "+trWriteList(numEntries)+".";
687 }

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 676 of file translator_fa.h.

677 {
678 return ".را به ارث می برد "+trWriteList(numEntries)+".";
679 }

References trWriteList().

◆ trInitialValue()

DString TranslatorPersian::trInitialValue ( )
inlineoverridevirtual

Text shown before a multi-line variable/enum initialization

Implements Translator.

Definition at line 854 of file translator_fa.h.

855 {
856 return "مقدار اوليه :";
857 }

◆ trInvariant()

DString TranslatorPersian::trInvariant ( )
inlineoverridevirtual

Text for the \invariant command

Implements Translator.

Definition at line 849 of file translator_fa.h.

850 {
851 return "Invariant";
852 }

◆ trISOLang()

DString TranslatorPersian::trISOLang ( )
inlineoverridevirtual

Implements Translator.

Definition at line 96 of file translator_fa.h.

97 {
98 return "fa";
99 }

◆ trLegend()

DString TranslatorPersian::trLegend ( )
inlineoverridevirtual

text for the link to the legend page

Implements Translator.

Definition at line 1047 of file translator_fa.h.

1048 {
1049 return "راهنما";
1050 }

◆ 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 984 of file translator_fa.h.

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

References getDotImageExtension().

◆ trLegendTitle()

DString TranslatorPersian::trLegendTitle ( )
inlineoverridevirtual

title of the graph legend page

Implements Translator.

Definition at line 977 of file translator_fa.h.

978 {
979 return "راهنمای نمودار";
980 }

◆ trListOfAllMembers()

DString TranslatorPersian::trListOfAllMembers ( )
inlineoverridevirtual

put in the class documentation

Implements Translator.

Definition at line 153 of file translator_fa.h.

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

◆ trLoading()

DString TranslatorPersian::trLoading ( )
inlineoverridevirtual

Loading message shown when loading search results

Implements Translator.

Definition at line 1702 of file translator_fa.h.

1703 {
1704 return "در حال بارگذاری...";
1705 }

◆ 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 779 of file translator_fa.h.

780 { 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 1242 of file translator_fa.h.

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

◆ trMemberDataDocumentation()

DString TranslatorPersian::trMemberDataDocumentation ( )
inlineoverridevirtual

header that is put before the list of member attributes.

Implements Translator.

Definition at line 136 of file translator_fa.h.

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

References Config_getBool.

◆ trMemberEnumerationDocumentation()

DString TranslatorPersian::trMemberEnumerationDocumentation ( )
inlineoverridevirtual

header that is put before the list of enumerations.

Implements Translator.

Definition at line 128 of file translator_fa.h.

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

◆ trMemberFunctionDocumentation()

DString TranslatorPersian::trMemberFunctionDocumentation ( )
inlineoverridevirtual

header that is put before the list of member functions.

Implements Translator.

Definition at line 132 of file translator_fa.h.

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

◆ trMemberFunctionDocumentationFortran()

DString TranslatorPersian::trMemberFunctionDocumentationFortran ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1525 of file translator_fa.h.

1526 { 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 157 of file translator_fa.h.

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

◆ trMemberTypedefDocumentation()

DString TranslatorPersian::trMemberTypedefDocumentation ( )
inlineoverridevirtual

header that is put before the list of typedefs.

Implements Translator.

Definition at line 124 of file translator_fa.h.

125 { 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 1637 of file translator_fa.h.

1638 {
1639 DString result("ماژول");
1640 if (!singular) result+=" ها";
1641 return result;
1642 }

◆ 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 385 of file translator_fa.h.

386 { 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 352 of file translator_fa.h.

353 { 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 1609 of file translator_fa.h.

1610 {
1611 DString result=namespaceName;
1612 result+=" Module Reference";
1613 return result;
1614 }

◆ 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 195 of file translator_fa.h.

196 { 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 339 of file translator_fa.h.

340 { 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 1630 of file translator_fa.h.

1631 { 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 1577 of file translator_fa.h.

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

◆ trModulesListDescription()

DString TranslatorPersian::trModulesListDescription ( bool )
inlineoverridevirtual

used as an introduction to the modules list (Fortran)

Implements Translator.

Definition at line 1581 of file translator_fa.h.

1582 {
1583 DString result="لیست ماژول ها به همراه توضیحات کوتاه";
1584 return result;
1585 }

◆ trModulesMemberDescription()

DString TranslatorPersian::trModulesMemberDescription ( bool )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1621 of file translator_fa.h.

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

◆ 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 1617 of file translator_fa.h.

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

◆ trMonth()

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

Implements Translator.

Definition at line 1784 of file translator_fa.h.

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

◆ trMore()

DString TranslatorPersian::trMore ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 149 of file translator_fa.h.

150 { 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 1209 of file translator_fa.h.

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

◆ 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 727 of file translator_fa.h.

728 { 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 721 of file translator_fa.h.

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

◆ trNamespaceList()

DString TranslatorPersian::trNamespaceList ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 558 of file translator_fa.h.

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

◆ trNamespaceListDescription()

DString TranslatorPersian::trNamespaceListDescription ( bool extractAll)
inlineoverridevirtual

used as an introduction to the namespace list

Implements Translator.

Definition at line 562 of file translator_fa.h.

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

◆ trNamespaceMemberDescription()

DString TranslatorPersian::trNamespaceMemberDescription ( bool extractAll)
inlineoverridevirtual

This is an introduction to the page with all namespace members

Implements Translator.

Definition at line 710 of file translator_fa.h.

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

◆ trNamespaceMembers()

DString TranslatorPersian::trNamespaceMembers ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 706 of file translator_fa.h.

707 { 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 621 of file translator_fa.h.

622 {
623 DString result=namespaceName;
624 result+=" مرجع فضای نام";
625 return result;
626 }

◆ 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 737 of file translator_fa.h.

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

◆ trNoMatches()

DString TranslatorPersian::trNoMatches ( )
inlineoverridevirtual

Text shown when no search results are found

Implements Translator.

Definition at line 1720 of file translator_fa.h.

1721 {
1722 return "یافت نشد";
1723 }

◆ trNote()

DString TranslatorPersian::trNote ( )
inlineoverridevirtual

Implements Translator.

Definition at line 884 of file translator_fa.h.

885 {
886 return "نکته";
887 }

◆ 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 1504 of file translator_fa.h.

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

◆ trPackage()

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

Used as the title of a Java package

Implements Translator.

Definition at line 1099 of file translator_fa.h.

1100 {
1101 return "Package "+name;
1102 }

◆ trPackageAttribs()

DString TranslatorPersian::trPackageAttribs ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1376 of file translator_fa.h.

1377 {
1378 return "خواص بسته ها";
1379 }

◆ trPackageFunctions()

DString TranslatorPersian::trPackageFunctions ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1358 of file translator_fa.h.

1359 {
1360 return "توابع بسته ها";
1361 }

◆ trPackageListDescription()

DString TranslatorPersian::trPackageListDescription ( )
inlineoverridevirtual

The description of the package index page

Implements Translator.

Definition at line 1104 of file translator_fa.h.

1105 {
1106 return "لیست بسته ها به همراه توضیح مختر در صورت وجود :";
1107 }

◆ trPackageMembers()

DString TranslatorPersian::trPackageMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 1362 of file translator_fa.h.

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

◆ trPackages()

DString TranslatorPersian::trPackages ( )
inlineoverridevirtual

The link name in the Quick links header for each page

Implements Translator.

Definition at line 1109 of file translator_fa.h.

1110 {
1111 return "بسته ها";
1112 }

◆ trPackageTypes()

DString TranslatorPersian::trPackageTypes ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1351 of file translator_fa.h.

1352 {
1353 return "انواع بسته ها";
1354 }

◆ 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 1231 of file translator_fa.h.

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

◆ 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 785 of file translator_fa.h.

786 { return "ص."; }

◆ trPageIndex()

DString TranslatorPersian::trPageIndex ( )
inlineoverridevirtual

Implements Translator.

Definition at line 875 of file translator_fa.h.

876 {
877 return "فهرست صفحات";
878 }

◆ trParameters()

DString TranslatorPersian::trParameters ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 542 of file translator_fa.h.

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

◆ trPostcondition()

DString TranslatorPersian::trPostcondition ( )
inlineoverridevirtual

Text for the \post command

Implements Translator.

Definition at line 844 of file translator_fa.h.

845 {
846 return "پس شرط";
847 }

◆ trPrecondition()

DString TranslatorPersian::trPrecondition ( )
inlineoverridevirtual

Text for the \pre command

Implements Translator.

Definition at line 839 of file translator_fa.h.

840 {
841 return "پیش شرط";
842 }

◆ trPrivateAttribs()

DString TranslatorPersian::trPrivateAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 923 of file translator_fa.h.

924 {
925 return "خواص (متغييرهای) خصوصی";
926 }

◆ trPrivateMembers()

DString TranslatorPersian::trPrivateMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 642 of file translator_fa.h.

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

◆ trPrivateSlots()

DString TranslatorPersian::trPrivateSlots ( )
inlineoverridevirtual

Implements Translator.

Definition at line 644 of file translator_fa.h.

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

◆ trPrivateTypes()

DString TranslatorPersian::trPrivateTypes ( )
inlineoverridevirtual

Implements Translator.

Definition at line 919 of file translator_fa.h.

920 {
921 return "های خصوصی Type";
922 }

◆ trProperties()

DString TranslatorPersian::trProperties ( )
inlineoverridevirtual

Used as a section header for IDL properties

Implements Translator.

Definition at line 1072 of file translator_fa.h.

1073 {
1074 return "خاصیت ها";
1075 }

◆ trPropertyDocumentation()

DString TranslatorPersian::trPropertyDocumentation ( )
inlineoverridevirtual

Used as a section header for IDL property documentation

Implements Translator.

Definition at line 1077 of file translator_fa.h.

1078 {
1079 return "مستندات خاصیت";
1080 }

◆ trProtectedAttribs()

DString TranslatorPersian::trProtectedAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 911 of file translator_fa.h.

912 {
913 return "خواص (متغييرهای) حفاظت شده";
914 }

◆ trProtectedMembers()

DString TranslatorPersian::trProtectedMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 636 of file translator_fa.h.

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

◆ trProtectedSlots()

DString TranslatorPersian::trProtectedSlots ( )
inlineoverridevirtual

Implements Translator.

Definition at line 638 of file translator_fa.h.

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

◆ trProtectedTypes()

DString TranslatorPersian::trProtectedTypes ( )
inlineoverridevirtual

Implements Translator.

Definition at line 907 of file translator_fa.h.

908 {
909 return "های حفاظت شده Type";
910 }

◆ trPublicAttribs()

DString TranslatorPersian::trPublicAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 892 of file translator_fa.h.

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

References Config_getBool.

◆ trPublicMembers()

DString TranslatorPersian::trPublicMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 628 of file translator_fa.h.

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

◆ trPublicSlots()

DString TranslatorPersian::trPublicSlots ( )
inlineoverridevirtual

Implements Translator.

Definition at line 630 of file translator_fa.h.

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

◆ trPublicTypes()

DString TranslatorPersian::trPublicTypes ( )
inlineoverridevirtual

Implements Translator.

Definition at line 888 of file translator_fa.h.

889 {
890 return "های عمومی Type";
891 }

◆ trReferencedBy()

DString TranslatorPersian::trReferencedBy ( )
inlineoverridevirtual

Implements Translator.

Definition at line 951 of file translator_fa.h.

952 {
953 return " استفاده شده توسط ";
954 }

◆ trReferenceManual()

DString TranslatorPersian::trReferenceManual ( )
inlineoverridevirtual

This is used in LaTeX as the title of the document

Implements Translator.

Definition at line 414 of file translator_fa.h.

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

◆ trReferences()

DString TranslatorPersian::trReferences ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1279 of file translator_fa.h.

1280 {
1281 return "را استفاده ميکند ";
1282 }

◆ 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 692 of file translator_fa.h.

693 {
694 return "Reimplemented from "+trWriteList(numEntries)+".";
695 }

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 700 of file translator_fa.h.

701 {
702 return "تعریف شده است "+trWriteList(numEntries)+"دوباره در ";
703 }

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 583 of file translator_fa.h.

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

◆ trRelatedFunctions()

DString TranslatorPersian::trRelatedFunctions ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 108 of file translator_fa.h.

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

◆ trRelatedPages()

DString TranslatorPersian::trRelatedPages ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 246 of file translator_fa.h.

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

◆ trRelatedPagesDescription()

DString TranslatorPersian::trRelatedPagesDescription ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 335 of file translator_fa.h.

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

◆ trRelatedSubscript()

DString TranslatorPersian::trRelatedSubscript ( )
inlineoverridevirtual

subscript for the related functions.

Implements Translator.

Definition at line 112 of file translator_fa.h.

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

◆ trRemarks()

DString TranslatorPersian::trRemarks ( )
inlineoverridevirtual

Implements Translator.

Definition at line 955 of file translator_fa.h.

956 {
957 return "ملاحظات";
958 }

◆ trReturns()

DString TranslatorPersian::trReturns ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 534 of file translator_fa.h.

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

◆ trReturnValues()

DString TranslatorPersian::trReturnValues ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 774 of file translator_fa.h.

775 { 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 1163 of file translator_fa.h.

1164 {
1165 return "1256";
1166 }

◆ 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 1172 of file translator_fa.h.

1173 {
1174 return "178";
1175 }

◆ trRTFGeneralIndex()

DString TranslatorPersian::trRTFGeneralIndex ( )
inlineoverridevirtual

Used as header RTF general index

Implements Translator.

Definition at line 1178 of file translator_fa.h.

1179 {
1180 return "فهرست";
1181 }

◆ trRTFTableOfContents()

DString TranslatorPersian::trRTFTableOfContents ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1311 of file translator_fa.h.

1312 {
1313 return "فهرست";
1314 }

◆ trSearch()

DString TranslatorPersian::trSearch ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 254 of file translator_fa.h.

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

◆ trSearching()

DString TranslatorPersian::trSearching ( )
inlineoverridevirtual

Message shown while searching

Implements Translator.

Definition at line 1714 of file translator_fa.h.

1715 {
1716 return "در حال جستجو...";
1717 }

◆ 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 1443 of file translator_fa.h.

1444 {
1445 return "Matches:";
1446 }

◆ 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 1424 of file translator_fa.h.

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

◆ trSearchResultsTitle()

DString TranslatorPersian::trSearchResultsTitle ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 1412 of file translator_fa.h.

1413 {
1414 return "نتايج جستجو";
1415 }

◆ trSeeAlso()

DString TranslatorPersian::trSeeAlso ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 538 of file translator_fa.h.

539 { return "See also"; }

◆ trSignals()

DString TranslatorPersian::trSignals ( )
inlineoverridevirtual

Implements Translator.

Definition at line 632 of file translator_fa.h.

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

◆ trSince()

DString TranslatorPersian::trSince ( )
inlineoverridevirtual

Implements Translator.

Definition at line 967 of file translator_fa.h.

968 {
969 return "از";
970 }

◆ 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 1454 of file translator_fa.h.

1455 {
1456 return filename + " کد و پرونده منبع";
1457 }

◆ 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 1383 of file translator_fa.h.

1384 {
1385 return "Static Package Attributes";
1386 }

◆ 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 1369 of file translator_fa.h.

1370 {
1371 return "Static Package Functions";
1372 }

◆ trStaticPrivateAttribs()

DString TranslatorPersian::trStaticPrivateAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 927 of file translator_fa.h.

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

◆ trStaticPrivateMembers()

DString TranslatorPersian::trStaticPrivateMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 646 of file translator_fa.h.

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

◆ trStaticProtectedAttribs()

DString TranslatorPersian::trStaticProtectedAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 915 of file translator_fa.h.

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

◆ trStaticProtectedMembers()

DString TranslatorPersian::trStaticProtectedMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 640 of file translator_fa.h.

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

◆ trStaticPublicAttribs()

DString TranslatorPersian::trStaticPublicAttribs ( )
inlineoverridevirtual

Implements Translator.

Definition at line 903 of file translator_fa.h.

904 {
905 return "خواص (متغييرهای) عمومی ثابت";
906 }

◆ trStaticPublicMembers()

DString TranslatorPersian::trStaticPublicMembers ( )
inlineoverridevirtual

Implements Translator.

Definition at line 634 of file translator_fa.h.

635 { 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 1678 of file translator_fa.h.

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

◆ 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 1567 of file translator_fa.h.

1568 { 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 1561 of file translator_fa.h.

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

◆ trTest()

DString TranslatorPersian::trTest ( )
inlineoverridevirtual

Used as a marker that is put before a test item

Implements Translator.

Definition at line 1057 of file translator_fa.h.

1058 {
1059 return "تست";
1060 }

◆ trTestList()

DString TranslatorPersian::trTestList ( )
inlineoverridevirtual

Used as the header of the test list

Implements Translator.

Definition at line 1062 of file translator_fa.h.

1063 {
1064 return "Test List";
1065 }

◆ 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 161 of file translator_fa.h.

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

◆ trTodo()

DString TranslatorPersian::trTodo ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 937 of file translator_fa.h.

938 {
939 return "برای انجام";
940 }

◆ trTodoList()

DString TranslatorPersian::trTodoList ( )
inlineoverridevirtual

Used as the header of the todo list

Implements Translator.

Definition at line 942 of file translator_fa.h.

943 {
944 return "ليست کارهاي آينده";
945 }

◆ 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 1670 of file translator_fa.h.

1671 {
1672 return createNoun(first_capital, singular, "type", "s");
1673 }
DString createNoun(bool first_capital, bool singular, const DString &base, const DString &plurSuffix, const DString &singSuffix="")
Definition translator.h:799

References Translator::createNoun().

◆ trTypeConstraints()

DString TranslatorPersian::trTypeConstraints ( )
inlineoverridevirtual

C# Type Constraint list

Implements Translator.

Definition at line 1686 of file translator_fa.h.

1687 {
1688 return "Type Constraints";
1689 }

◆ 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 462 of file translator_fa.h.

463 { 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 426 of file translator_fa.h.

427 { 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 1555 of file translator_fa.h.

1556 { 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 486 of file translator_fa.h.

487 { 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 444 of file translator_fa.h.

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

◆ trVersion()

DString TranslatorPersian::trVersion ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 526 of file translator_fa.h.

527 { return "نسخه"; }

◆ trWarning()

DString TranslatorPersian::trWarning ( )
inlineoverridevirtual

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

Implements Translator.

Definition at line 522 of file translator_fa.h.

523 { 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 652 of file translator_fa.h.

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

References generateMarker().

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


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