The TranslatorPersian Class Reference

Declaration

class TranslatorPersian { ... }

Included Headers

#include <src/translator_fa.h>

Base class

class	TranslatorAdapter_1_7_5
	Adapter class for languages that only contain translations up to version 1.7.5. More...

Public Member Functions Index

QCString	idLanguage () override
QCString	latexLanguageSupportCommand () override
QCString	latexCommandName () override
QCString	trISOLang () override
QCString	getLanguageString () override
	language codes for Html help More...
QCString	trRelatedFunctions () override
QCString	trRelatedSubscript () override
QCString	trDetailedDescription () override
QCString	trDetails () override
QCString	trMemberTypedefDocumentation () override
QCString	trMemberEnumerationDocumentation () override
QCString	trMemberFunctionDocumentation () override
QCString	trMemberDataDocumentation () override
QCString	trMore () override
QCString	trListOfAllMembers () override
QCString	trMemberList () override
QCString	trThisIsTheListOfAllMembers () override
QCString	trIncludingInheritedMembers () override
QCString	trGeneratedAutomatically (const QCString &s) override
QCString	trEnumName () override
QCString	trEnumValue () override
QCString	trDefinedIn () override
QCString	trModules () override
QCString	trClassHierarchy () override
QCString	trCompoundList () override
QCString	trFileList () override
QCString	trCompoundMembers () override
QCString	trFileMembers () override
QCString	trRelatedPages () override
QCString	trExamples () override
QCString	trSearch () override
QCString	trClassHierarchyDescription () override
QCString	trFileListDescription (bool extractAll) override
QCString	trCompoundListDescription () override
QCString	trCompoundMembersDescription (bool extractAll) override
QCString	trFileMembersDescription (bool extractAll) override
QCString	trExamplesDescription () override
QCString	trRelatedPagesDescription () override
QCString	trModulesDescription () override
QCString	trDocumentation (const QCString &projName) override
QCString	trModuleIndex () override
QCString	trHierarchicalIndex () override
QCString	trCompoundIndex () override
QCString	trFileIndex () override
QCString	trModuleDocumentation () override
QCString	trClassDocumentation () override
QCString	trFileDocumentation () override
QCString	trReferenceManual () override
QCString	trDefines () override
QCString	trTypedefs () override
QCString	trEnumerations () override
QCString	trFunctions () override
QCString	trVariables () override
QCString	trEnumerationValues () override
QCString	trDefineDocumentation () override
QCString	trTypedefDocumentation () override
QCString	trEnumerationTypeDocumentation () override
QCString	trEnumerationValueDocumentation () override
QCString	trFunctionDocumentation () override
QCString	trVariableDocumentation () override
QCString	trCompounds () override
QCString	trGeneratedAt (const QCString &date, const QCString &projName) override
QCString	trClassDiagram (const QCString &clName) override
QCString	trWarning () override
QCString	trVersion () override
QCString	trDate () override
QCString	trReturns () override
QCString	trSeeAlso () override
QCString	trParameters () override
QCString	trExceptions () override
QCString	trGeneratedBy () override
QCString	trNamespaceList () override
QCString	trNamespaceListDescription (bool extractAll) override
QCString	trFriends () override
QCString	trRelatedFunctionDocumentation () override
QCString	trCompoundReference (const QCString &clName, ClassDef::CompoundType compType, bool isTemplate) override
QCString	trFileReference (const QCString &fileName) override
QCString	trNamespaceReference (const QCString &namespaceName) override
QCString	trPublicMembers () override
QCString	trPublicSlots () override
QCString	trSignals () override
QCString	trStaticPublicMembers () override
QCString	trProtectedMembers () override
QCString	trProtectedSlots () override
QCString	trStaticProtectedMembers () override
QCString	trPrivateMembers () override
QCString	trPrivateSlots () override
QCString	trStaticPrivateMembers () override
QCString	trWriteList (int numEntries) override
QCString	trInheritsList (int numEntries) override
QCString	trInheritedByList (int numEntries) override
QCString	trReimplementedFromList (int numEntries) override
QCString	trReimplementedInList (int numEntries) override
QCString	trNamespaceMembers () override
QCString	trNamespaceMemberDescription (bool extractAll) override
QCString	trNamespaceIndex () override
QCString	trNamespaceDocumentation () override
QCString	trNamespaces () override
QCString	trGeneratedFromFiles (ClassDef::CompoundType compType, bool single) override
QCString	trReturnValues () override
QCString	trMainPage () override
QCString	trPageAbbreviation () override
QCString	trDefinedAtLineInSourceFile () override
QCString	trDefinedInSourceFile () override
QCString	trDeprecated () override
QCString	trCollaborationDiagram (const QCString &clName) override
QCString	trInclDepGraph (const QCString &fName) override
QCString	trConstructorDocumentation () override
QCString	trGotoSourceCode () override
QCString	trGotoDocumentation () override
QCString	trPrecondition () override
QCString	trPostcondition () override
QCString	trInvariant () override
QCString	trInitialValue () override
QCString	trCode () override
QCString	trGraphicalHierarchy () override
QCString	trGotoGraphicalHierarchy () override
QCString	trGotoTextualHierarchy () override
QCString	trPageIndex () override
QCString	trNote () override
QCString	trPublicTypes () override
QCString	trPublicAttribs () override
QCString	trStaticPublicAttribs () override
QCString	trProtectedTypes () override
QCString	trProtectedAttribs () override
QCString	trStaticProtectedAttribs () override
QCString	trPrivateTypes () override
QCString	trPrivateAttribs () override
QCString	trStaticPrivateAttribs () override
QCString	trTodo () override
QCString	trTodoList () override
QCString	trReferencedBy () override
QCString	trRemarks () override
QCString	trAttention () override
QCString	trInclByDepGraph () override
QCString	trSince () override
QCString	trLegendTitle () override
QCString	trLegendDocs () override
QCString	trLegend () override
QCString	trTest () override
QCString	trTestList () override
QCString	trProperties () override
QCString	trPropertyDocumentation () override
QCString	trClasses () override
QCString	trPackage (const QCString &name) override
QCString	trPackageListDescription () override
QCString	trPackages () override
QCString	trDefineValue () override
QCString	trBug () override
QCString	trBugList () override
QCString	trRTFansicp () override
QCString	trRTFCharSet () override
QCString	trRTFGeneralIndex () override
QCString	trClass (bool first_capital, bool singular) override
QCString	trFile (bool, bool singular) override
QCString	trNamespace (bool first_capital, bool singular) override
QCString	trGroup (bool first_capital, bool singular) override
QCString	trPage (bool first_capital, bool singular) override
QCString	trMember (bool first_capital, bool singular) override
QCString	trGlobal (bool first_capital, bool singular) override
QCString	trAuthor (bool first_capital, bool singular) override
QCString	trReferences () override
QCString	trImplementedFromList (int numEntries) override
QCString	trImplementedInList (int numEntries) override
QCString	trRTFTableOfContents () override
QCString	trDeprecatedList () override
QCString	trEvents () override
QCString	trEventDocumentation () override
QCString	trPackageTypes () override
QCString	trPackageFunctions () override
QCString	trPackageMembers () override
QCString	trStaticPackageFunctions () override
QCString	trPackageAttribs () override
QCString	trStaticPackageAttribs () override
QCString	trAll () override
QCString	trCallGraph () override
QCString	trSearchResultsTitle () override
QCString	trSearchResults (int numDocuments) override
QCString	trSearchMatches () override
QCString	trSourceFile (const QCString &filename) override
QCString	trDirIndex () override
QCString	trDirDocumentation () override
QCString	trDirectories () override
QCString	trDirReference (const QCString &dirName) override
QCString	trDir (bool, bool singular) override
QCString	trOverloadText () override
QCString	trCallerGraph () override
QCString	trMemberFunctionDocumentationFortran () override
QCString	trCompoundListFortran () override
QCString	trCompoundMembersFortran () override
QCString	trCompoundListDescriptionFortran () override
QCString	trCompoundMembersDescriptionFortran (bool) override
QCString	trCompoundIndexFortran () override
QCString	trTypeDocumentation () override
QCString	trSubprograms () override
QCString	trSubprogramDocumentation () override
QCString	trDataTypes () override
QCString	trModulesList () override
QCString	trModulesListDescription (bool) override
QCString	trCompoundReferenceFortran (const QCString &clName, ClassDef::CompoundType compType, bool isTemplate) override
QCString	trModuleReference (const QCString &namespaceName) override
QCString	trModulesMembers () override
QCString	trModulesMemberDescription (bool) override
QCString	trModulesIndex () override
QCString	trModule (bool, bool singular) override
QCString	trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single) override
QCString	trType (bool first_capital, bool singular) override
QCString	trSubprogram (bool, bool singular) override
QCString	trTypeConstraints () override
QCString	trDirRelation (const QCString &name) override
QCString	trLoading () override
QCString	trGlobalNamespace () override
QCString	trSearching () override
QCString	trNoMatches () override
QCString	trFileIn (const QCString &name) override
QCString	trIncludesFileIn (const QCString &name) override
QCString	trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime) override
	Compiles a date string. More...
QCString	trDayOfWeek (int dayOfWeek, bool, bool full) override
QCString	trMonth (int month, bool, bool full) override
QCString	trDayPeriod (bool period) override

Private Member Functions Index

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

Definition at line 42 of file translator_fa.h.

Public Member Functions

getLanguageString()

QCString TranslatorPersian::getLanguageString ()

inline virtual

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)

Definition at line 104 of file translator_fa.h.

104 QCString getLanguageString() override

105 {

106 return "0x429 Persian (Iran)";

107 }

idLanguage()

QCString TranslatorPersian::idLanguage ()

inline virtual

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.

Definition at line 72 of file translator_fa.h.

72 QCString idLanguage() override

73 { return "persian"; }

latexCommandName()

QCString TranslatorPersian::latexCommandName ()

inline virtual

Set the name to be used as latex command.

Definition at line 94 of file translator_fa.h.

94 QCString latexCommandName() override

95 {

96 return p_latexCommandName("xelatex");

97 }

Reference Translator::p_latexCommandName.

latexLanguageSupportCommand()

QCString TranslatorPersian::latexLanguageSupportCommand ()

inline virtual

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.

Definition at line 89 of file translator_fa.h.

89 QCString latexLanguageSupportCommand() override

90 {

91 return "";

92 }

trAll()

QCString TranslatorPersian::trAll ()

inline virtual

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

Definition at line 1398 of file translator_fa.h.

1398 QCString trAll() override

1399 {

1400 return "همه";

1401 }

trAttention()

QCString TranslatorPersian::trAttention ()

inline virtual

Definition at line 962 of file translator_fa.h.

962 QCString trAttention() override

963 {

964 return "توجه";

965 }

trAuthor()

QCString TranslatorPersian::trAuthor (bool first_capital, bool singular)

inline virtual

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

Definition at line 1269 of file translator_fa.h.

1269 QCString trAuthor(bool first_capital, bool singular) override

1270 {

1271 QCString result((first_capital ? "Author" : "author"));

1272 if (!singular) result+="s";

1273 return result;

1274 }

trBug()

QCString TranslatorPersian::trBug ()

inline virtual

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

Definition at line 1127 of file translator_fa.h.

1127 QCString trBug() override

1128 {

1129 return "اشکال";

1130 }

trBugList()

QCString TranslatorPersian::trBugList ()

inline virtual

Used as the header of the bug list

Definition at line 1132 of file translator_fa.h.

1132 QCString trBugList() override

1133 {

1134 return "ليست اشکالات";

1135 }

trCallerGraph()

QCString TranslatorPersian::trCallerGraph ()

inline virtual

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

Definition at line 1519 of file translator_fa.h.

1519 QCString trCallerGraph() override

1520 {

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

1522 }

trCallGraph()

QCString TranslatorPersian::trCallGraph ()

inline virtual

Put in front of the call graph for a function.

Definition at line 1403 of file translator_fa.h.

1403 QCString trCallGraph() override

1404 {

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

1406 }

trClass()

QCString TranslatorPersian::trClass (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1190 of file translator_fa.h.

1190 QCString trClass(bool first_capital, bool singular) override

1191 {

1192 QCString result((first_capital ? "کلاس" : "کلاس"));

1193 if (!singular) result+="ها";

1194 return result;

1195 }

trClassDiagram()

QCString TranslatorPersian::trClassDiagram (const QCString & clName)

inline virtual

this text is put before a class diagram

Definition at line 519 of file translator_fa.h.

519 QCString trClassDiagram(const QCString &clName) override

520 {

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

522 }

trClassDocumentation()

QCString TranslatorPersian::trClassDocumentation ()

inline virtual

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

Definition at line 394 of file translator_fa.h.

394 QCString trClassDocumentation() override

395 {

396 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

397 {

398 return "مستندات ساختار داده ها";

399 }

400 else if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))

401 {

402 return trDesignUnitDocumentation();

403 }

404 else

405 {

406 return "مستندات کلاس ها";

407 }

408 }

References Config_getBool and TranslatorAdapter_1_8_19::trDesignUnitDocumentation.

trClasses()

QCString TranslatorPersian::trClasses ()

inline virtual

Used for Java classes in the summary section of Java packages

Definition at line 1090 of file translator_fa.h.

1090 QCString trClasses() override

1091 {

1092 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

1093 {

1094 return "ساختار های داده";

1095 }

1096 else

1097 {

1098 return "كلاس ها";

1099 }

1100 }

Reference Config_getBool.

trClassHierarchy()

QCString TranslatorPersian::trClassHierarchy ()

inline virtual

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

Definition at line 202 of file translator_fa.h.

202 QCString trClassHierarchy() override

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

trClassHierarchyDescription()

QCString TranslatorPersian::trClassHierarchyDescription ()

inline virtual

This is an introduction to the class hierarchy.

Definition at line 261 of file translator_fa.h.

261 QCString trClassHierarchyDescription() override

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

263 }

trCode()

QCString TranslatorPersian::trCode ()

inline virtual

Text used the source code in the file index

Definition at line 862 of file translator_fa.h.

862 QCString trCode() override

863 {

864 return "کد";

865 }

trCollaborationDiagram()

QCString TranslatorPersian::trCollaborationDiagram (const QCString & clName)

inline virtual

this text is put before a collaboration diagram

Definition at line 817 of file translator_fa.h.

817 QCString trCollaborationDiagram(const QCString &clName) override

818 {

819 return "Collaboration diagram for "+clName+":";

820 }

trCompoundIndex()

QCString TranslatorPersian::trCompoundIndex ()

inline virtual

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

Definition at line 367 of file translator_fa.h.

367 QCString trCompoundIndex() override

368 {

369 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

370 {

371 return "فهرست ساختار داده ها";

372 }

373 else

374 {

375 return "فهرست کلاس های";

376 }

377 }

Reference Config_getBool.

trCompoundIndexFortran()

QCString TranslatorPersian::trCompoundIndexFortran ()

inline virtual

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

Definition at line 1552 of file translator_fa.h.

1552 QCString trCompoundIndexFortran() override

1553 { return "Data Type Index"; }

trCompoundList()

QCString TranslatorPersian::trCompoundList ()

inline virtual

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

Definition at line 206 of file translator_fa.h.

206 QCString trCompoundList() override

207 {

208 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

209 {

210 return "ساختار های داده ";

211 }

212 else

213 {

214 return "ليست کلاس ها ";

215 }

216 }

Reference Config_getBool.

trCompoundListDescription()

QCString TranslatorPersian::trCompoundListDescription ()

inline virtual

This is an introduction to the annotated compound list.

Definition at line 275 of file translator_fa.h.

275 QCString trCompoundListDescription() override

276 {

277

278 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

279 {

280 return "ليست ساختارهای داده به همراه توضيحی کوتاه :";

281 }

282 else

283 {

284 return "ليست کلاس ها ، ساختارهای داده و ... به همراه توضيحات مختصر راجع به آنها :";

285 }

286 }

Reference Config_getBool.

trCompoundListDescriptionFortran()

QCString TranslatorPersian::trCompoundListDescriptionFortran ()

inline virtual

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

Definition at line 1540 of file translator_fa.h.

1540 QCString trCompoundListDescriptionFortran() override

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

trCompoundListFortran()

QCString TranslatorPersian::trCompoundListFortran ()

inline virtual

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

Definition at line 1532 of file translator_fa.h.

1532 QCString trCompoundListFortran() override

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

trCompoundMembers()

QCString TranslatorPersian::trCompoundMembers ()

inline virtual

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

Definition at line 223 of file translator_fa.h.

223 QCString trCompoundMembers() override

224 {

225 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

226 {

227 return "فضاهای داده ها";

228 }

229 else

230 {

231 return "اعضاء کلاس ها";

232 }

233 }

Reference Config_getBool.

trCompoundMembersDescription()

QCString TranslatorPersian::trCompoundMembersDescription (bool extractAll)

inline virtual

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

Definition at line 289 of file translator_fa.h.

289 QCString trCompoundMembersDescription(bool extractAll) override

290 {

291 QCString result=" در ذيل ليست ";

292 if (!extractAll)

293 {

294 result+="آن اعضايي که مستند شده اند ";

295 }

296 else

297 {

298 result+="همه ی اعضاء ";

299 }

300 result+=" به همراه ارتباطشان با ";

301 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

302 {

303 result+="ساختارهای داده ";

304 }

305 else

306 {

307 result+="كلاس ها ";

308 }

309

310 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

311 {

312 result+="و مستندات ساختار داده برای هر عضو ";

313 }

314 else

315 {

316 result+="و مستندات کلاس برای هر عضو ";

317 }

318 result+="را مشاهده ميکنيد :";

319 return result;

320 }

Reference Config_getBool.

trCompoundMembersDescriptionFortran()

QCString TranslatorPersian::trCompoundMembersDescriptionFortran (bool)

inline virtual

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

Definition at line 1544 of file translator_fa.h.

1544 QCString trCompoundMembersDescriptionFortran(bool) override

1545 {

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

1547 }

trCompoundMembersFortran()

QCString TranslatorPersian::trCompoundMembersFortran ()

inline virtual

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

Definition at line 1536 of file translator_fa.h.

1536 QCString trCompoundMembersFortran() override

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

trCompoundReference()

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

inline virtual

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

Definition at line 594 of file translator_fa.h.

594 QCString trCompoundReference(const QCString &clName,

595 ClassDef::CompoundType compType,

596 bool isTemplate) override

597 {

598 QCString result;

599 switch(compType)

600 {

601 case ClassDef::Class: result=" کلاس"; break;

602 case ClassDef::Struct: result=" ساختار داده"; break;

603 case ClassDef::Union: result=" Union"; break;

604 case ClassDef::Interface: result=" Interface"; break;

605 case ClassDef::Protocol: result=" Protocol"; break;

606 case ClassDef::Category: result=" Category"; break;

607 case ClassDef::Exception: result=" استثناء"; break;

608 default: break;

609 }

610 if (isTemplate) result+=" قالب";

611 result=QCString(clName) + " مرجع" +result ;

612 return result;

613 }

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

trCompoundReferenceFortran()

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

inline virtual

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

Definition at line 1591 of file translator_fa.h.

1591 QCString trCompoundReferenceFortran(const QCString &clName,

1592 ClassDef::CompoundType compType,

1593 bool isTemplate) override

1594 {

1595 QCString result=clName;

1596 switch(compType)

1597 {

1598 case ClassDef::Class: result+=" Module"; break;

1599 case ClassDef::Struct: result+=" Type"; break;

1600 case ClassDef::Union: result+=" Union"; break;

1601 case ClassDef::Interface: result+=" Interface"; break;

1602 case ClassDef::Protocol: result+=" Protocol"; break;

1603 case ClassDef::Category: result+=" Category"; break;

1604 case ClassDef::Exception: result+=" Exception"; break;

1605 default: break;

1606 }

1607 if (isTemplate) result+=" Template";

1608 result+=" Reference";

1609 return result;

1610 }

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

trCompounds()

QCString TranslatorPersian::trCompounds ()

inline virtual

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

Definition at line 495 of file translator_fa.h.

495 QCString trCompounds() override

496 {

497 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

498 {

499 return "ساختارهای داده";

500 }

501 else

502 {

503 return "کلاس ها";

504 }

505 }

Reference Config_getBool.

trConstructorDocumentation()

QCString TranslatorPersian::trConstructorDocumentation ()

inline virtual

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

Definition at line 827 of file translator_fa.h.

827 QCString trConstructorDocumentation() override

828 {

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

830 }

trDataTypes()

QCString TranslatorPersian::trDataTypes ()

inline virtual

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

Definition at line 1576 of file translator_fa.h.

1576 QCString trDataTypes() override

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

trDate()

QCString TranslatorPersian::trDate ()

inline virtual

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

Definition at line 533 of file translator_fa.h.

533 QCString trDate() override

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

trDateTime()

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

inline virtual

Compiles a date string.

Parameters

year	Year in 4 digits
month	Month of the year: 1=January
day	Day of the Month: 1..31
dayOfWeek	Day of the week: 1=Monday..7=Sunday
hour	Hour of the day: 0..23
minutes	Minutes in the hour: 0..59
seconds	Seconds within the minute: 0..59
includeTime	Include time in the result string?

Definition at line 1760 of file translator_fa.h.

1760 QCString trDateTime(int year,int month,int day,int dayOfWeek,

1761 int hour,int minutes,int seconds,

1762 DateTimeType includeTime) override

1763 {

1764 static const char *days[] = { "دوشنبه","سه‌شنبه","چهارشنبه","پنجشنبه","جمعه","شنبه","یکشنبه" };

1765 static const char *months[] = { "ژانویه","فوریه","مارس","آوریل","می","جون","جولای","آگوست","سپتامبر","اکتبر","نوامبر","دسامبر" };

1766 QCString sdate;

1767 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Date)

1768 {

1769 sdate.sprintf("%s %d %s %d",days[dayOfWeek-1],day,months[month-1],year);

1770 }

1771 if (includeTime == DateTimeType::DateTime) sdate += " ";

1772 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Time)

1773 {

1774 QCString stime;

1775 stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);

1776 sdate+=stime;

1777 }

1778 return convertDigitsToFarsi(sdate);

1779 }

References convertDigitsToFarsi, Date, DateTime, QCString::sprintf and Time.

trDayOfWeek()

QCString TranslatorPersian::trDayOfWeek (int dayOfWeek, bool, bool full)

inline virtual

Definition at line 1780 of file translator_fa.h.

1780 QCString trDayOfWeek(int dayOfWeek, bool, bool full) override

1781 {

1782 static const char *days_short[] = { "دوشنبه", "سه شنبه", "چهارشنبه", "پنجشنبه", "جمعه", "شنبه", "يكشنبه" };

1783 static const char *days_full[] = { "دوشنبه", "سه شنبه", "چهارشنبه", "پنجشنبه", "جمعه", "شنبه", "يكشنبه" };

1784 QCString text = full? days_full[dayOfWeek-1] : days_short[dayOfWeek-1];

1785 return text;

1786 }

trDayPeriod()

QCString TranslatorPersian::trDayPeriod (bool period)

inline virtual

Definition at line 1794 of file translator_fa.h.

1794 QCString trDayPeriod(bool period) override

1795 {

1796 static const char *dayPeriod[] = { "قبل‌ازظهر", "بعدازظهر" };

1797 return dayPeriod[period?1:0];

1798 }

trDefinedAtLineInSourceFile()

QCString TranslatorPersian::trDefinedAtLineInSourceFile ()

inline virtual

Definition at line 794 of file translator_fa.h.

794 QCString trDefinedAtLineInSourceFile() override

795 {

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

797 }

trDefinedIn()

QCString TranslatorPersian::trDefinedIn ()

inline virtual

put after an undocumented member in the list of all members

Definition at line 190 of file translator_fa.h.

190 QCString trDefinedIn() override

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

trDefinedInSourceFile()

QCString TranslatorPersian::trDefinedInSourceFile ()

inline virtual

Definition at line 798 of file translator_fa.h.

798 QCString trDefinedInSourceFile() override

799 {

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

801 }

trDefineDocumentation()

QCString TranslatorPersian::trDefineDocumentation ()

inline virtual

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

Definition at line 459 of file translator_fa.h.

459 QCString trDefineDocumentation() override

460 { return "Define Documentation"; }

trDefines()

QCString TranslatorPersian::trDefines ()

inline virtual

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

Definition at line 423 of file translator_fa.h.

423 QCString trDefines() override

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

trDefineValue()

QCString TranslatorPersian::trDefineValue ()

inline virtual

Text shown before a multi-line define

Definition at line 1117 of file translator_fa.h.

1117 QCString trDefineValue() override

1118 {

1119 return "مقدار:";

1120 }

trDeprecated()

QCString TranslatorPersian::trDeprecated ()

inline virtual

Definition at line 807 of file translator_fa.h.

807 QCString trDeprecated() override

808 {

809 return "منسوخ شده";

810 }

trDeprecatedList()

QCString TranslatorPersian::trDeprecatedList ()

inline virtual

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

Definition at line 1326 of file translator_fa.h.

1326 QCString trDeprecatedList() override

1327 {

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

1329 }

trDetailedDescription()

QCString TranslatorPersian::trDetailedDescription ()

inline virtual

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

Definition at line 119 of file translator_fa.h.

119 QCString trDetailedDescription() override

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

trDetails()

QCString TranslatorPersian::trDetails ()

inline virtual

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

Definition at line 123 of file translator_fa.h.

123 QCString trDetails() override

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

trDir()

QCString TranslatorPersian::trDir (bool, bool singular)

inline virtual

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

Definition at line 1493 of file translator_fa.h.

1493 QCString trDir(bool /*first_capital*/, bool singular) override

1494 {

1495 QCString result("شاخه");

1496 if (singular) result+=" ها "+result;

1497 return result;

1498 }

trDirDocumentation()

QCString TranslatorPersian::trDirDocumentation ()

inline virtual

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

Definition at line 1475 of file translator_fa.h.

1475 QCString trDirDocumentation() override

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

trDirectories()

QCString TranslatorPersian::trDirectories ()

inline virtual

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.

Definition at line 1481 of file translator_fa.h.

1481 QCString trDirectories() override

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

trDirIndex()

QCString TranslatorPersian::trDirIndex ()

inline virtual

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

Definition at line 1469 of file translator_fa.h.

1469 QCString trDirIndex() override

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

trDirReference()

QCString TranslatorPersian::trDirReference (const QCString & dirName)

inline virtual

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

Definition at line 1487 of file translator_fa.h.

1487 QCString trDirReference(const QCString &dirName) override

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

trDirRelation()

QCString TranslatorPersian::trDirRelation (const QCString & name)

inline virtual

directory relation for name

Definition at line 1699 of file translator_fa.h.

1699 QCString trDirRelation(const QCString &name) override

1700 {

1701 return QCString(name) + " Relation";

1702 }

trDocumentation()

QCString TranslatorPersian::trDocumentation (const QCString & projName)

inline virtual

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

Definition at line 349 of file translator_fa.h.

349 QCString trDocumentation(const QCString &projName) override

350 { return "مستندات" + (!projName.isEmpty()?" " + projName : ""); }

Reference QCString::isEmpty.

trEnumerations()

QCString TranslatorPersian::trEnumerations ()

inline virtual

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

Definition at line 435 of file translator_fa.h.

435 QCString trEnumerations() override

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

trEnumerationTypeDocumentation()

QCString TranslatorPersian::trEnumerationTypeDocumentation ()

inline virtual

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

Definition at line 471 of file translator_fa.h.

471 QCString trEnumerationTypeDocumentation() override

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

trEnumerationValueDocumentation()

QCString TranslatorPersian::trEnumerationValueDocumentation ()

inline virtual

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

Definition at line 477 of file translator_fa.h.

477 QCString trEnumerationValueDocumentation() override

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

trEnumerationValues()

QCString TranslatorPersian::trEnumerationValues ()

inline virtual

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

Definition at line 453 of file translator_fa.h.

453 QCString trEnumerationValues() override

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

trEnumName()

QCString TranslatorPersian::trEnumName ()

inline virtual

put after an enum name in the list of all members

Definition at line 182 of file translator_fa.h.

182 QCString trEnumName() override

183 { return "enum نام"; }

trEnumValue()

QCString TranslatorPersian::trEnumValue ()

inline virtual

put after an enum value in the list of all members

Definition at line 186 of file translator_fa.h.

186 QCString trEnumValue() override

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

trEventDocumentation()

QCString TranslatorPersian::trEventDocumentation ()

inline virtual

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

Definition at line 1343 of file translator_fa.h.

1343 QCString trEventDocumentation() override

1344 {

1345 return "مستندات رویداد";

1346 }

trEvents()

QCString TranslatorPersian::trEvents ()

inline virtual

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

Definition at line 1338 of file translator_fa.h.

1338 QCString trEvents() override

1339 {

1340 return "رویداد ها";

1341 }

trExamples()

QCString TranslatorPersian::trExamples ()

inline virtual

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

Definition at line 253 of file translator_fa.h.

253 QCString trExamples() override

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

trExamplesDescription()

QCString TranslatorPersian::trExamplesDescription ()

inline virtual

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

Definition at line 334 of file translator_fa.h.

334 QCString trExamplesDescription() override

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

trExceptions()

QCString TranslatorPersian::trExceptions ()

inline virtual

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

Definition at line 549 of file translator_fa.h.

549 QCString trExceptions() override

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

trFile()

QCString TranslatorPersian::trFile (bool, bool singular)

inline virtual

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.

Definition at line 1201 of file translator_fa.h.

1201 QCString trFile(bool /*first_capital*/, bool singular) override

1202 {

1203 QCString result("پرونده");

1204 if (!singular) result=result+" ها";

1205 return result;

1206 }

trFileDocumentation()

QCString TranslatorPersian::trFileDocumentation ()

inline virtual

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

Definition at line 413 of file translator_fa.h.

413 QCString trFileDocumentation() override

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

trFileIn()

QCString TranslatorPersian::trFileIn (const QCString & name)

inline virtual

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.

Definition at line 1736 of file translator_fa.h.

1736 QCString trFileIn(const QCString &name) override

1737 {

1738 return "پرونده ای در "+name;

1739 }

trFileIndex()

QCString TranslatorPersian::trFileIndex ()

inline virtual

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

Definition at line 382 of file translator_fa.h.

382 QCString trFileIndex() override

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

trFileList()

QCString TranslatorPersian::trFileList ()

inline virtual

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

Definition at line 219 of file translator_fa.h.

219 QCString trFileList() override

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

trFileListDescription()

QCString TranslatorPersian::trFileListDescription (bool extractAll)

inline virtual

This is an introduction to the list with all files.

Definition at line 266 of file translator_fa.h.

266 QCString trFileListDescription(bool extractAll) override

267 {

268 QCString result="ليست همه ي پرونده های ";

269 if (!extractAll) result+="(مستند شده) ";

270 result+=" :";

271 return result;

272 }

trFileMembers()

QCString TranslatorPersian::trFileMembers ()

inline virtual

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

Definition at line 236 of file translator_fa.h.

236 QCString trFileMembers() override

237 {

238 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

239 {

240 return "Globals";

241 }

242 else

243 {

244 return "اعضاء پرونده";

245 }

246 }

Reference Config_getBool.

trFileMembersDescription()

QCString TranslatorPersian::trFileMembersDescription (bool extractAll)

inline virtual

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

Definition at line 323 of file translator_fa.h.

323 QCString trFileMembersDescription(bool extractAll) override

324 {

325 QCString result="ليست همه ی توابع ، متغيير ها، تعاريف و ... ";

326 if (!extractAll) result+="(مستند شده) ";

327

328 result+=" به همراه ارتباط آنها ";

329 result+="با پرونده هايی که به آن مربوط اند :";

330 return result;

331 }

trFileReference()

QCString TranslatorPersian::trFileReference (const QCString & fileName)

inline virtual

used as the title of the HTML page of a file

Definition at line 616 of file translator_fa.h.

616 QCString trFileReference(const QCString &fileName) override

617 {

618 QCString result=fileName;

619 result+=" مرجع پرونده";

620 return result;

621 }

trFriends()

QCString TranslatorPersian::trFriends ()

inline virtual

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

Definition at line 576 of file translator_fa.h.

576 QCString trFriends() override

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

trFunctionDocumentation()

QCString TranslatorPersian::trFunctionDocumentation ()

inline virtual

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

Definition at line 483 of file translator_fa.h.

483 QCString trFunctionDocumentation() override

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

trFunctions()

QCString TranslatorPersian::trFunctions ()

inline virtual

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

Definition at line 441 of file translator_fa.h.

441 QCString trFunctions() override

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

trGeneratedAt()

QCString TranslatorPersian::trGeneratedAt (const QCString & date, const QCString & projName)

inline virtual

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

Definition at line 510 of file translator_fa.h.

510 QCString trGeneratedAt(const QCString &date,const QCString &projName) override

511 {

512 QCString result = HtmlDivEnd + HtmlRightToLeft + QCString("توليد شده در ") +date ;

513 if (!projName.isEmpty()) result+=" برای "+projName;

514 result+=" توسط";

515 return result;

516 }

References HtmlDivEnd, HtmlRightToLeft and QCString::isEmpty.

trGeneratedAutomatically()

QCString TranslatorPersian::trGeneratedAutomatically (const QCString & s)

inline virtual

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

Definition at line 174 of file translator_fa.h.

174 QCString trGeneratedAutomatically(const QCString &s) override

175 { QCString result="تولید شده توسط نرم افزار دی اکسیژن ";

176 if (!s.isEmpty()) result+=" برای "+s;

177 result+=" از کد برنامه ";

178 return result;

179 }

Reference QCString::isEmpty.

trGeneratedBy()

QCString TranslatorPersian::trGeneratedBy ()

inline virtual

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

Definition at line 553 of file translator_fa.h.

553 QCString trGeneratedBy() override

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

trGeneratedFromFiles()

QCString TranslatorPersian::trGeneratedFromFiles (ClassDef::CompoundType compType, bool single)

inline virtual

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.

Definition at line 750 of file translator_fa.h.

750 QCString trGeneratedFromFiles(ClassDef::CompoundType compType,

751 bool single) override

752 { // here s is one of " Class", " Struct" or " Union"

753 // single is true implies a single file

754 QCString result="مستندات اين ";

755 switch(compType)

756 {

757 case ClassDef::Class: result+="کلاس"; break;

758 case ClassDef::Struct: result+="ساختار داده"; break;

759 case ClassDef::Union: result+="union"; break;

760 case ClassDef::Interface: result+="interface"; break;

761 case ClassDef::Protocol: result+="protocol"; break;

762 case ClassDef::Category: result+="category"; break;

763 case ClassDef::Exception: result+="exception"; break;

764 default: break;

765 }

766 result+=" از روی پرونده ";

767 if (single) result+=""; else result+="های ";

768 result+="زير توليد شده است :";

769 return result;

770 }

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

trGeneratedFromFilesFortran()

QCString TranslatorPersian::trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single)

inline virtual

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.

Definition at line 1649 of file translator_fa.h.

1649 QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType,

1650 bool single) override

1651 { // here s is one of " Module", " Struct" or " Union"

1652 // single is true implies a single file

1653 QCString result="The documentation for this ";

1654 switch(compType)

1655 {

1656 case ClassDef::Class: result+="module"; break;

1657 case ClassDef::Struct: result+="type"; break;

1658 case ClassDef::Union: result+="union"; break;

1659 case ClassDef::Interface: result+="interface"; break;

1660 case ClassDef::Protocol: result+="protocol"; break;

1661 case ClassDef::Category: result+="category"; break;

1662 case ClassDef::Exception: result+="exception"; break;

1663 default: break;

1664 }

1665 result+=" was generated from the following file";

1666 if (single) result+=":"; else result+="s:";

1667 return result;

1668 }

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

trGlobal()

QCString TranslatorPersian::trGlobal (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1256 of file translator_fa.h.

1256 QCString trGlobal(bool first_capital, bool singular) override

1257 {

1258 QCString result((first_capital ? "Global" : "global"));

1259 if (!singular) result+="s";

1260 return result;

1261 }

trGlobalNamespace()

QCString TranslatorPersian::trGlobalNamespace ()

inline virtual

Label used for search results in the global namespace

Definition at line 1711 of file translator_fa.h.

1711 QCString trGlobalNamespace() override

1712 {

1713 return "فضای نام جهانی";

1714 }

trGotoDocumentation()

QCString TranslatorPersian::trGotoDocumentation ()

inline virtual

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

Definition at line 837 of file translator_fa.h.

837 QCString trGotoDocumentation() override

838 {

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

840 }

trGotoGraphicalHierarchy()

QCString TranslatorPersian::trGotoGraphicalHierarchy ()

inline virtual

Definition at line 870 of file translator_fa.h.

870 QCString trGotoGraphicalHierarchy() override

871 {

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

873 }

trGotoSourceCode()

QCString TranslatorPersian::trGotoSourceCode ()

inline virtual

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

Definition at line 832 of file translator_fa.h.

832 QCString trGotoSourceCode() override

833 {

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

835 }

trGotoTextualHierarchy()

QCString TranslatorPersian::trGotoTextualHierarchy ()

inline virtual

Definition at line 874 of file translator_fa.h.

874 QCString trGotoTextualHierarchy() override

875 {

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

877 }

trGraphicalHierarchy()

QCString TranslatorPersian::trGraphicalHierarchy ()

inline virtual

Definition at line 866 of file translator_fa.h.

866 QCString trGraphicalHierarchy() override

867 {

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

869 }

trGroup()

QCString TranslatorPersian::trGroup (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1223 of file translator_fa.h.

1223 QCString trGroup(bool first_capital, bool singular) override

1224 {

1225 QCString result((first_capital ? "Group" : "group"));

1226 if (!singular) result+="s";

1227 return result;

1228 }

trHierarchicalIndex()

QCString TranslatorPersian::trHierarchicalIndex ()

inline virtual

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

Definition at line 361 of file translator_fa.h.

361 QCString trHierarchicalIndex() override

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

trImplementedFromList()

QCString TranslatorPersian::trImplementedFromList (int numEntries)

inline virtual

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

Definition at line 1294 of file translator_fa.h.

1294 QCString trImplementedFromList(int numEntries) override

1295 {

1296 return "را تکميل می کند "+trWriteList(numEntries)+".";

1297 }

Reference trWriteList.

trImplementedInList()

QCString TranslatorPersian::trImplementedInList (int numEntries)

inline virtual

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

Definition at line 1302 of file translator_fa.h.

1302 QCString trImplementedInList(int numEntries) override

1303 {

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

1305 }

Reference trWriteList.

trInclByDepGraph()

QCString TranslatorPersian::trInclByDepGraph ()

inline virtual

Definition at line 966 of file translator_fa.h.

966 QCString trInclByDepGraph() override

967 {

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

969 }

trInclDepGraph()

QCString TranslatorPersian::trInclDepGraph (const QCString & fName)

inline virtual

this text is put before an include dependency graph

Definition at line 822 of file translator_fa.h.

822 QCString trInclDepGraph(const QCString &fName) override

823 {

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

825 }

trIncludesFileIn()

QCString TranslatorPersian::trIncludesFileIn (const QCString & name)

inline virtual

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.

Definition at line 1745 of file translator_fa.h.

1745 QCString trIncludesFileIn(const QCString &name) override

1746 {

1747 return "Includes file in "+name;

1748 }

trIncludingInheritedMembers()

QCString TranslatorPersian::trIncludingInheritedMembers ()

inline virtual

this is the remainder of the sentence after the class name

Definition at line 168 of file translator_fa.h.

168 QCString trIncludingInheritedMembers() override

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

trInheritedByList()

QCString TranslatorPersian::trInheritedByList (int numEntries)

inline virtual

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

Definition at line 687 of file translator_fa.h.

687 QCString trInheritedByList(int numEntries) override

688 {

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

690 }

Reference trWriteList.

trInheritsList()

QCString TranslatorPersian::trInheritsList (int numEntries)

inline virtual

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

Definition at line 679 of file translator_fa.h.

679 QCString trInheritsList(int numEntries) override

680 {

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

682 }

Reference trWriteList.

trInitialValue()

QCString TranslatorPersian::trInitialValue ()

inline virtual

Text shown before a multi-line variable/enum initialization

Definition at line 857 of file translator_fa.h.

857 QCString trInitialValue() override

858 {

859 return "مقدار اوليه :";

860 }

trInvariant()

QCString TranslatorPersian::trInvariant ()

inline virtual

Text for the \invariant command

Definition at line 852 of file translator_fa.h.

852 QCString trInvariant() override

853 {

854 return "Invariant";

855 }

trISOLang()

QCString TranslatorPersian::trISOLang ()

inline virtual

Definition at line 99 of file translator_fa.h.

99 QCString trISOLang() override

100 {

101 return "fa";

102 }

trLegend()

QCString TranslatorPersian::trLegend ()

inline virtual

text for the link to the legend page

Definition at line 1050 of file translator_fa.h.

1050 QCString trLegend() override

1051 {

1052 return "راهنما";

1053 }

trLegendDocs()

QCString TranslatorPersian::trLegendDocs ()

inline virtual

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

Definition at line 987 of file translator_fa.h.

987 QCString trLegendDocs() override

988 {

989 return

990 "This page explains how to interpret the graphs that are generated "

991 "by doxygen.<p>\n"

992 "Consider the following example:\n"

993 "\\code\n"

994 "/*! Invisible class because of truncation */\n"

995 "class Invisible { };\n\n"

996 "/*! Truncated class, inheritance relation is hidden */\n"

997 "class Truncated : public Invisible { };\n\n"

998 "/* Class not documented with doxygen comments */\n"

999 "class Undocumented { };\n\n"

1000 "/*! Class that is inherited using public inheritance */\n"

1001 "class PublicBase : public Truncated { };\n\n"

1002 "/*! A template class */\n"

1003 "template<class T> class Templ { };\n\n"

1004 "/*! Class that is inherited using protected inheritance */\n"

1005 "class ProtectedBase { };\n\n"

1006 "/*! Class that is inherited using private inheritance */\n"

1007 "class PrivateBase { };\n\n"

1008 "/*! Class that is used by the Inherited class */\n"

1009 "class Used { };\n\n"

1010 "/*! Super class that inherits a number of other classes */\n"

1011 "class Inherited : public PublicBase,\n"

1012 " protected ProtectedBase,\n"

1013 " private PrivateBase,\n"

1014 " public Undocumented\n"

1015 " public Templ<int>\n"

1016 "{\n"

1017 " private:\n"

1018 " Used *m_usedClass;\n"

1019 "};\n"

1020 "\\endcode\n"

1021 "If the \\c MAX_DOT_GRAPH_HEIGHT tag in the configuration file "

1022 "is set to 240 this will result in the following graph:"

1023 "<p><center><img alt=\"\" src=\"graph_legend."+getDotImageExtension()+"\"></center>\n"

1024 "<p>\n"

1025 "The boxes in the above graph have the following meaning:\n"

1026 "<ul>\n"

1027 "<li>%A filled black box represents the struct or class for which the "

1028 "graph is generated.\n"

1029 "<li>%A box with a black border denotes a documented struct or class.\n"

1030 "<li>%A box with a gray border denotes an undocumented struct or class.\n"

1031 "<li>%A box with a red border denotes a documented struct or class for"

1032 "which not all inheritance/containment relations are shown. %A graph is "

1033 "truncated if it does not fit within the specified boundaries.\n"

1034 "</ul>\n"

1035 "The arrows have the following meaning:\n"

1036 "<ul>\n"

1037 "<li>%A dark blue arrow is used to visualize a public inheritance "

1038 "relation between two classes.\n"

1039 "<li>%A dark green arrow is used for protected inheritance.\n"

1040 "<li>%A dark red arrow is used for private inheritance.\n"

1041 "<li>%A purple dashed arrow is used if a class is contained or used "

1042 "by another class. The arrow is labeled with the variable(s) "

1043 "through which the pointed class or struct is accessible.\n"

1044 "<li>%A yellow dashed arrow denotes a relation between a template instance and "

1045 "the template class it was instantiated from. The arrow is labeled with "

1046 "the template parameters of the instance.\n"

1047 "</ul>\n";

1048 }

Reference getDotImageExtension.

trLegendTitle()

QCString TranslatorPersian::trLegendTitle ()

inline virtual

title of the graph legend page

Definition at line 980 of file translator_fa.h.

980 QCString trLegendTitle() override

981 {

982 return "راهنمای نمودار";

983 }

trListOfAllMembers()

QCString TranslatorPersian::trListOfAllMembers ()

inline virtual

put in the class documentation

Definition at line 156 of file translator_fa.h.

156 QCString trListOfAllMembers() override

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

trLoading()

QCString TranslatorPersian::trLoading ()

inline virtual

Loading message shown when loading search results

Definition at line 1705 of file translator_fa.h.

1705 QCString trLoading() override

1706 {

1707 return "در حال بارگذاری...";

1708 }

trMainPage()

QCString TranslatorPersian::trMainPage ()

inline virtual

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

Definition at line 782 of file translator_fa.h.

782 QCString trMainPage() override

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

trMember()

QCString TranslatorPersian::trMember (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1245 of file translator_fa.h.

1245 QCString trMember(bool first_capital, bool singular) override

1246 {

1247 QCString result((first_capital ? "عضو" : "عضو"));

1248 if (!singular) result+="ها";

1249 return result;

1250 }

trMemberDataDocumentation()

QCString TranslatorPersian::trMemberDataDocumentation ()

inline virtual

header that is put before the list of member attributes.

Definition at line 139 of file translator_fa.h.

139 QCString trMemberDataDocumentation() override

140 {

141 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

142 {

143 return "Field مستندات";

144 }

145 else

146 {

147 return "مستندات متغيير های عضو";

148 }

149 }

Reference Config_getBool.

trMemberEnumerationDocumentation()

QCString TranslatorPersian::trMemberEnumerationDocumentation ()

inline virtual

header that is put before the list of enumerations.

Definition at line 131 of file translator_fa.h.

131 QCString trMemberEnumerationDocumentation() override

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

trMemberFunctionDocumentation()

QCString TranslatorPersian::trMemberFunctionDocumentation ()

inline virtual

header that is put before the list of member functions.

Definition at line 135 of file translator_fa.h.

135 QCString trMemberFunctionDocumentation() override

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

trMemberFunctionDocumentationFortran()

QCString TranslatorPersian::trMemberFunctionDocumentationFortran ()

inline virtual

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

Definition at line 1528 of file translator_fa.h.

1528 QCString trMemberFunctionDocumentationFortran() override

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

trMemberList()

QCString TranslatorPersian::trMemberList ()

inline virtual

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

Definition at line 160 of file translator_fa.h.

160 QCString trMemberList() override

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

trMemberTypedefDocumentation()

QCString TranslatorPersian::trMemberTypedefDocumentation ()

inline virtual

header that is put before the list of typedefs.

Definition at line 127 of file translator_fa.h.

127 QCString trMemberTypedefDocumentation() override

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

trModule()

QCString TranslatorPersian::trModule (bool, bool singular)

inline virtual

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.

Definition at line 1640 of file translator_fa.h.

1640 QCString trModule(bool, bool singular) override

1641 {

1642 QCString result("ماژول");

1643 if (!singular) result+=" ها";

1644 return result;

1645 }

trModuleDocumentation()

QCString TranslatorPersian::trModuleDocumentation ()

inline virtual

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

Definition at line 388 of file translator_fa.h.

388 QCString trModuleDocumentation() override

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

trModuleIndex()

QCString TranslatorPersian::trModuleIndex ()

inline virtual

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

Definition at line 355 of file translator_fa.h.

355 QCString trModuleIndex() override

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

trModuleReference()

QCString TranslatorPersian::trModuleReference (const QCString & namespaceName)

inline virtual

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

Definition at line 1612 of file translator_fa.h.

1612 QCString trModuleReference(const QCString &namespaceName) override

1613 {

1614 QCString result=namespaceName;

1615 result+=" Module Reference";

1616 return result;

1617 }

trModules()

QCString TranslatorPersian::trModules ()

inline virtual

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

Definition at line 198 of file translator_fa.h.

198 QCString trModules() override

199 { return "Modules"; }

trModulesDescription()

QCString TranslatorPersian::trModulesDescription ()

inline virtual

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

Definition at line 342 of file translator_fa.h.

342 QCString trModulesDescription() override

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

trModulesIndex()

QCString TranslatorPersian::trModulesIndex ()

inline virtual

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

Definition at line 1633 of file translator_fa.h.

1633 QCString trModulesIndex() override

1634 { return "Modules Index"; }

trModulesList()

QCString TranslatorPersian::trModulesList ()

inline virtual

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

Definition at line 1580 of file translator_fa.h.

1580 QCString trModulesList() override

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

trModulesListDescription()

QCString TranslatorPersian::trModulesListDescription (bool)

inline virtual

used as an introduction to the modules list (Fortran)

Definition at line 1584 of file translator_fa.h.

1584 QCString trModulesListDescription(bool) override

1585 {

1586 QCString result="لیست ماژول ها به همراه توضیحات کوتاه";

1587 return result;

1588 }

trModulesMemberDescription()

QCString TranslatorPersian::trModulesMemberDescription (bool)

inline virtual

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

Definition at line 1624 of file translator_fa.h.

1624 QCString trModulesMemberDescription(bool) override

1625 {

1626 QCString result="لیست اعضاء ماژول ها به همراه مستندات ماژول مربوطه";

1627 return result;

1628 }

trModulesMembers()

QCString TranslatorPersian::trModulesMembers ()

inline virtual

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

Definition at line 1620 of file translator_fa.h.

1620 QCString trModulesMembers() override

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

trMonth()

QCString TranslatorPersian::trMonth (int month, bool, bool full)

inline virtual

Definition at line 1787 of file translator_fa.h.

1787 QCString trMonth(int month, bool, bool full) override

1788 {

1789 static const char *months_short[] = { "ژانويه", "فوريه", "مارس", "آوريل", "مه", "ژوئن", "ژوئيه", "اوت", "سپتامبر", "اُكتبر", "نوامبر", "دسامبر" };

1790 static const char *months_full[] = { "ژانويه", "فوريه", "مارس", "آوريل", "مه", "ژوئن", "ژوئيه", "اوت", "سپتامبر", "اُكتبر", "نوامبر", "دسامبر" };

1791 QCString text = full? months_full[month-1] : months_short[month-1];

1792 return text;

1793 }

trMore()

QCString TranslatorPersian::trMore ()

inline virtual

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

Definition at line 152 of file translator_fa.h.

152 QCString trMore() override

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

trNamespace()

QCString TranslatorPersian::trNamespace (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1212 of file translator_fa.h.

1212 QCString trNamespace(bool first_capital, bool singular) override

1213 {

1214 QCString result((first_capital ? "فضای نام " : "فضای نام "));

1215 if (!singular) result+="ها";

1216 return result;

1217 }

trNamespaceDocumentation()

QCString TranslatorPersian::trNamespaceDocumentation ()

inline virtual

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

Definition at line 730 of file translator_fa.h.

730 QCString trNamespaceDocumentation() override

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

trNamespaceIndex()

QCString TranslatorPersian::trNamespaceIndex ()

inline virtual

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

Definition at line 724 of file translator_fa.h.

724 QCString trNamespaceIndex() override

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

trNamespaceList()

QCString TranslatorPersian::trNamespaceList ()

inline virtual

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

Definition at line 561 of file translator_fa.h.

561 QCString trNamespaceList() override

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

trNamespaceListDescription()

QCString TranslatorPersian::trNamespaceListDescription (bool extractAll)

inline virtual

used as an introduction to the namespace list

Definition at line 565 of file translator_fa.h.

565 QCString trNamespaceListDescription(bool extractAll) override

566 {

567 QCString result="در ذيل ليستی از همه ی فضاهای نام ";

568 if (!extractAll) result+="(مستند سازی شده) ";

569 result+="به همراه توضيح کوتاه آنها مشاهده می کنيد :";

570 return result;

571 }

trNamespaceMemberDescription()

QCString TranslatorPersian::trNamespaceMemberDescription (bool extractAll)

inline virtual

This is an introduction to the page with all namespace members

Definition at line 713 of file translator_fa.h.

713 QCString trNamespaceMemberDescription(bool extractAll) override

714 {

715 QCString result="ليست همه اعضای فضای نام ";

716 if (!extractAll) result+="(مستند شده) ";

717 result+=" با ارتباطشان با";

718 result+="فضاهای نامی که به آن مربوط اند را مشاهده ميکنيد :";

719 return result;

720 }

trNamespaceMembers()

QCString TranslatorPersian::trNamespaceMembers ()

inline virtual

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

Definition at line 709 of file translator_fa.h.

709 QCString trNamespaceMembers() override

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

trNamespaceReference()

QCString TranslatorPersian::trNamespaceReference (const QCString & namespaceName)

inline virtual

used as the title of the HTML page of a namespace

Definition at line 624 of file translator_fa.h.

624 QCString trNamespaceReference(const QCString &namespaceName) override

625 {

626 QCString result=namespaceName;

627 result+=" مرجع فضای نام";

628 return result;

629 }

trNamespaces()

QCString TranslatorPersian::trNamespaces ()

inline virtual

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

Definition at line 740 of file translator_fa.h.

740 QCString trNamespaces() override

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

trNoMatches()

QCString TranslatorPersian::trNoMatches ()

inline virtual

Text shown when no search results are found

Definition at line 1723 of file translator_fa.h.

1723 QCString trNoMatches() override

1724 {

1725 return "یافت نشد";

1726 }

trNote()

QCString TranslatorPersian::trNote ()

inline virtual

Definition at line 887 of file translator_fa.h.

887 QCString trNote() override

888 {

889 return "نکته";

890 }

trOverloadText()

QCString TranslatorPersian::trOverloadText ()

inline virtual

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

Definition at line 1507 of file translator_fa.h.

1507 QCString trOverloadText() override

1508 {

1509 return "This is an overloaded member function, "

1510 "provided for convenience. It differs from the above "

1511 "function only in what argument(s) it accepts.";

1512 }

trPackage()

QCString TranslatorPersian::trPackage (const QCString & name)

inline virtual

Used as the title of a Java package

Definition at line 1102 of file translator_fa.h.

1102 QCString trPackage(const QCString &name) override

1103 {

1104 return "Package "+name;

1105 }

trPackageAttribs()

QCString TranslatorPersian::trPackageAttribs ()

inline virtual

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

Definition at line 1379 of file translator_fa.h.

1379 QCString trPackageAttribs() override

1380 {

1381 return "خواص بسته ها";

1382 }

trPackageFunctions()

QCString TranslatorPersian::trPackageFunctions ()

inline virtual

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

Definition at line 1361 of file translator_fa.h.

1361 QCString trPackageFunctions() override

1362 {

1363 return "توابع بسته ها";

1364 }

trPackageListDescription()

QCString TranslatorPersian::trPackageListDescription ()

inline virtual

The description of the package index page

Definition at line 1107 of file translator_fa.h.

1107 QCString trPackageListDescription() override

1108 {

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

1110 }

trPackageMembers()

QCString TranslatorPersian::trPackageMembers ()

inline virtual

Definition at line 1365 of file translator_fa.h.

1365 QCString trPackageMembers() override

1366 {

1367 return "عضوها بسته ها";

1368 }

trPackages()

QCString TranslatorPersian::trPackages ()

inline virtual

The link name in the Quick links header for each page

Definition at line 1112 of file translator_fa.h.

1112 QCString trPackages() override

1113 {

1114 return "بسته ها";

1115 }

trPackageTypes()

QCString TranslatorPersian::trPackageTypes ()

inline virtual

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

Definition at line 1354 of file translator_fa.h.

1354 QCString trPackageTypes() override

1355 {

1356 return "انواع بسته ها";

1357 }

trPage()

QCString TranslatorPersian::trPage (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1234 of file translator_fa.h.

1234 QCString trPage(bool first_capital, bool singular) override

1235 {

1236 QCString result((first_capital ? "صفحه" : "صفحه"));

1237 if (!singular) result+=" ها ";

1238 return result;

1239 }

trPageAbbreviation()

QCString TranslatorPersian::trPageAbbreviation ()

inline virtual

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

Definition at line 788 of file translator_fa.h.

788 QCString trPageAbbreviation() override

789 { return "ص."; }

trPageIndex()

QCString TranslatorPersian::trPageIndex ()

inline virtual

Definition at line 878 of file translator_fa.h.

878 QCString trPageIndex() override

879 {

880 return "فهرست صفحات";

881 }

trParameters()

QCString TranslatorPersian::trParameters ()

inline virtual

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

Definition at line 545 of file translator_fa.h.

545 QCString trParameters() override

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

trPostcondition()

QCString TranslatorPersian::trPostcondition ()

inline virtual

Text for the \post command

Definition at line 847 of file translator_fa.h.

847 QCString trPostcondition() override

848 {

849 return "پس شرط";

850 }

trPrecondition()

QCString TranslatorPersian::trPrecondition ()

inline virtual

Text for the \pre command

Definition at line 842 of file translator_fa.h.

842 QCString trPrecondition() override

843 {

844 return "پیش شرط";

845 }

trPrivateAttribs()

QCString TranslatorPersian::trPrivateAttribs ()

inline virtual

Definition at line 926 of file translator_fa.h.

926 QCString trPrivateAttribs() override

927 {

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

929 }

trPrivateMembers()

QCString TranslatorPersian::trPrivateMembers ()

inline virtual

Definition at line 645 of file translator_fa.h.

645 QCString trPrivateMembers() override

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

trPrivateSlots()

QCString TranslatorPersian::trPrivateSlots ()

inline virtual

Definition at line 647 of file translator_fa.h.

647 QCString trPrivateSlots() override

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

trPrivateTypes()

QCString TranslatorPersian::trPrivateTypes ()

inline virtual

Definition at line 922 of file translator_fa.h.

922 QCString trPrivateTypes() override

923 {

924 return "های خصوصی Type";

925 }

trProperties()

QCString TranslatorPersian::trProperties ()

inline virtual

Used as a section header for IDL properties

Definition at line 1075 of file translator_fa.h.

1075 QCString trProperties() override

1076 {

1077 return "خاصیت ها";

1078 }

trPropertyDocumentation()

QCString TranslatorPersian::trPropertyDocumentation ()

inline virtual

Used as a section header for IDL property documentation

Definition at line 1080 of file translator_fa.h.

1080 QCString trPropertyDocumentation() override

1081 {

1082 return "مستندات خاصیت";

1083 }

trProtectedAttribs()

QCString TranslatorPersian::trProtectedAttribs ()

inline virtual

Definition at line 914 of file translator_fa.h.

914 QCString trProtectedAttribs() override

915 {

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

917 }

trProtectedMembers()

QCString TranslatorPersian::trProtectedMembers ()

inline virtual

Definition at line 639 of file translator_fa.h.

639 QCString trProtectedMembers() override

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

trProtectedSlots()

QCString TranslatorPersian::trProtectedSlots ()

inline virtual

Definition at line 641 of file translator_fa.h.

641 QCString trProtectedSlots() override

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

trProtectedTypes()

QCString TranslatorPersian::trProtectedTypes ()

inline virtual

Definition at line 910 of file translator_fa.h.

910 QCString trProtectedTypes() override

911 {

912 return "های حفاظت شده Type";

913 }

trPublicAttribs()

QCString TranslatorPersian::trPublicAttribs ()

inline virtual

Definition at line 895 of file translator_fa.h.

895 QCString trPublicAttribs() override

896 {

897 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

898 {

899 return "فضاهای داده ها";

900 }

901 else

902 {

903 return "خواص (متغييرهای) عمومی";

904 }

905 }

Reference Config_getBool.

trPublicMembers()

QCString TranslatorPersian::trPublicMembers ()

inline virtual

Definition at line 631 of file translator_fa.h.

631 QCString trPublicMembers() override

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

trPublicSlots()

QCString TranslatorPersian::trPublicSlots ()

inline virtual

Definition at line 633 of file translator_fa.h.

633 QCString trPublicSlots() override

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

trPublicTypes()

QCString TranslatorPersian::trPublicTypes ()

inline virtual

Definition at line 891 of file translator_fa.h.

891 QCString trPublicTypes() override

892 {

893 return "های عمومی Type";

894 }

trReferencedBy()

QCString TranslatorPersian::trReferencedBy ()

inline virtual

Definition at line 954 of file translator_fa.h.

954 QCString trReferencedBy() override

955 {

956 return " استفاده شده توسط ";

957 }

trReferenceManual()

QCString TranslatorPersian::trReferenceManual ()

inline virtual

This is used in LaTeX as the title of the document

Definition at line 417 of file translator_fa.h.

417 QCString trReferenceManual() override

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

trReferences()

QCString TranslatorPersian::trReferences ()

inline virtual

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

Definition at line 1282 of file translator_fa.h.

1282 QCString trReferences() override

1283 {

1284 return "را استفاده ميکند ";

1285 }

trReimplementedFromList()

QCString TranslatorPersian::trReimplementedFromList (int numEntries)

inline virtual

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

Definition at line 695 of file translator_fa.h.

695 QCString trReimplementedFromList(int numEntries) override

696 {

697 return "Reimplemented from "+trWriteList(numEntries)+".";

698 }

Reference trWriteList.

trReimplementedInList()

QCString TranslatorPersian::trReimplementedInList (int numEntries)

inline virtual

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

Definition at line 703 of file translator_fa.h.

703 QCString trReimplementedInList(int numEntries) override

704 {

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

706 }

Reference trWriteList.

trRelatedFunctionDocumentation()

QCString TranslatorPersian::trRelatedFunctionDocumentation ()

inline virtual

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

Definition at line 586 of file translator_fa.h.

586 QCString trRelatedFunctionDocumentation() override

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

trRelatedFunctions()

QCString TranslatorPersian::trRelatedFunctions ()

inline virtual

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

Definition at line 111 of file translator_fa.h.

111 QCString trRelatedFunctions() override

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

trRelatedPages()

QCString TranslatorPersian::trRelatedPages ()

inline virtual

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

Definition at line 249 of file translator_fa.h.

249 QCString trRelatedPages() override

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

trRelatedPagesDescription()

QCString TranslatorPersian::trRelatedPagesDescription ()

inline virtual

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

Definition at line 338 of file translator_fa.h.

338 QCString trRelatedPagesDescription() override

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

trRelatedSubscript()

QCString TranslatorPersian::trRelatedSubscript ()

inline virtual

subscript for the related functions.

Definition at line 115 of file translator_fa.h.

115 QCString trRelatedSubscript() override

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

trRemarks()

QCString TranslatorPersian::trRemarks ()

inline virtual

Definition at line 958 of file translator_fa.h.

958 QCString trRemarks() override

959 {

960 return "ملاحظات";

961 }

trReturns()

QCString TranslatorPersian::trReturns ()

inline virtual

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

Definition at line 537 of file translator_fa.h.

537 QCString trReturns() override

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

trReturnValues()

QCString TranslatorPersian::trReturnValues ()

inline virtual

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

Definition at line 777 of file translator_fa.h.

777 QCString trReturnValues() override

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

trRTFansicp()

QCString TranslatorPersian::trRTFansicp ()

inline virtual

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

Definition at line 1166 of file translator_fa.h.

1166 QCString trRTFansicp() override

1167 {

1168 return "1256";

1169 }

trRTFCharSet()

QCString TranslatorPersian::trRTFCharSet ()

inline virtual

Used as ansicpg for RTF fcharset

See Also

trRTFansicp() for a table of possible values.

Definition at line 1175 of file translator_fa.h.

1175 QCString trRTFCharSet() override

1176 {

1177 return "178";

1178 }

trRTFGeneralIndex()

QCString TranslatorPersian::trRTFGeneralIndex ()

inline virtual

Used as header RTF general index

Definition at line 1181 of file translator_fa.h.

1181 QCString trRTFGeneralIndex() override

1182 {

1183 return "فهرست";

1184 }

trRTFTableOfContents()

QCString TranslatorPersian::trRTFTableOfContents ()

inline virtual

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

Definition at line 1314 of file translator_fa.h.

1314 QCString trRTFTableOfContents() override

1315 {

1316 return "فهرست";

1317 }

trSearch()

QCString TranslatorPersian::trSearch ()

inline virtual

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

Definition at line 257 of file translator_fa.h.

257 QCString trSearch() override

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

trSearching()

QCString TranslatorPersian::trSearching ()

inline virtual

Message shown while searching

Definition at line 1717 of file translator_fa.h.

1717 QCString trSearching() override

1718 {

1719 return "در حال جستجو...";

1720 }

trSearchMatches()

QCString TranslatorPersian::trSearchMatches ()

inline virtual

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.

Definition at line 1446 of file translator_fa.h.

1446 QCString trSearchMatches() override

1447 {

1448 return "Matches:";

1449 }

trSearchResults()

QCString TranslatorPersian::trSearchResults (int numDocuments)

inline virtual

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.

Definition at line 1427 of file translator_fa.h.

1427 QCString trSearchResults(int numDocuments) override

1428 {

1429 if (numDocuments==0)

1430 {

1431 return "متاسفانه هیچ صفحه ای برای جستجو ی شما یافت نشد.";

1432 }

1433 else if (numDocuments==1)

1434 {

1435 return "یک سند برای این مورد یافت شد.";

1436 }

1437 else

1438 {

1439 return "Found <b>$num</b> documents matching your query. "

1440 "Showing best matches first.";

1441 }

1442 }

trSearchResultsTitle()

QCString TranslatorPersian::trSearchResultsTitle ()

inline virtual

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

Definition at line 1415 of file translator_fa.h.

1415 QCString trSearchResultsTitle() override

1416 {

1417 return "نتايج جستجو";

1418 }

trSeeAlso()

QCString TranslatorPersian::trSeeAlso ()

inline virtual

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

Definition at line 541 of file translator_fa.h.

541 QCString trSeeAlso() override

542 { return "See also"; }

trSignals()

QCString TranslatorPersian::trSignals ()

inline virtual

Definition at line 635 of file translator_fa.h.

635 QCString trSignals() override

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

trSince()

QCString TranslatorPersian::trSince ()

inline virtual

Definition at line 970 of file translator_fa.h.

970 QCString trSince() override

971 {

972 return "از";

973 }

trSourceFile()

QCString TranslatorPersian::trSourceFile (const QCString & filename)

inline virtual

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

Definition at line 1457 of file translator_fa.h.

1457 QCString trSourceFile(const QCString& filename) override

1458 {

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

1460 }

trStaticPackageAttribs()

QCString TranslatorPersian::trStaticPackageAttribs ()

inline virtual

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

Definition at line 1386 of file translator_fa.h.

1386 QCString trStaticPackageAttribs() override

1387 {

1388 return "Static Package Attributes";

1389 }

trStaticPackageFunctions()

QCString TranslatorPersian::trStaticPackageFunctions ()

inline virtual

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

Definition at line 1372 of file translator_fa.h.

1372 QCString trStaticPackageFunctions() override

1373 {

1374 return "Static Package Functions";

1375 }

trStaticPrivateAttribs()

QCString TranslatorPersian::trStaticPrivateAttribs ()

inline virtual

Definition at line 930 of file translator_fa.h.

930 QCString trStaticPrivateAttribs() override

931 {

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

933 }

trStaticPrivateMembers()

QCString TranslatorPersian::trStaticPrivateMembers ()

inline virtual

Definition at line 649 of file translator_fa.h.

649 QCString trStaticPrivateMembers() override

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

trStaticProtectedAttribs()

QCString TranslatorPersian::trStaticProtectedAttribs ()

inline virtual

Definition at line 918 of file translator_fa.h.

918 QCString trStaticProtectedAttribs() override

919 {

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

921 }

trStaticProtectedMembers()

QCString TranslatorPersian::trStaticProtectedMembers ()

inline virtual

Definition at line 643 of file translator_fa.h.

643 QCString trStaticProtectedMembers() override

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

trStaticPublicAttribs()

QCString TranslatorPersian::trStaticPublicAttribs ()

inline virtual

Definition at line 906 of file translator_fa.h.

906 QCString trStaticPublicAttribs() override

907 {

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

909 }

trStaticPublicMembers()

QCString TranslatorPersian::trStaticPublicMembers ()

inline virtual

Definition at line 637 of file translator_fa.h.

637 QCString trStaticPublicMembers() override

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

trSubprogram()

QCString TranslatorPersian::trSubprogram (bool, bool singular)

inline virtual

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.

Definition at line 1681 of file translator_fa.h.

1681 QCString trSubprogram(bool, bool singular) override

1682 {

1683 QCString result("زیربرنامه");

1684 if (!singular) result+=" ها ";

1685 return result;

1686 }

trSubprogramDocumentation()

QCString TranslatorPersian::trSubprogramDocumentation ()

inline virtual

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

Definition at line 1570 of file translator_fa.h.

1570 QCString trSubprogramDocumentation() override

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

trSubprograms()

QCString TranslatorPersian::trSubprograms ()

inline virtual

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

Definition at line 1564 of file translator_fa.h.

1564 QCString trSubprograms() override

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

trTest()

QCString TranslatorPersian::trTest ()

inline virtual

Used as a marker that is put before a test item

Definition at line 1060 of file translator_fa.h.

1060 QCString trTest() override

1061 {

1062 return "تست";

1063 }

trTestList()

QCString TranslatorPersian::trTestList ()

inline virtual

Used as the header of the test list

Definition at line 1065 of file translator_fa.h.

1065 QCString trTestList() override

1066 {

1067 return "Test List";

1068 }

trThisIsTheListOfAllMembers()

QCString TranslatorPersian::trThisIsTheListOfAllMembers ()

inline virtual

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

Definition at line 164 of file translator_fa.h.

164 QCString trThisIsTheListOfAllMembers() override

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

trTodo()

QCString TranslatorPersian::trTodo ()

inline virtual

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

Definition at line 940 of file translator_fa.h.

940 QCString trTodo() override

941 {

942 return "برای انجام";

943 }

trTodoList()

QCString TranslatorPersian::trTodoList ()

inline virtual

Used as the header of the todo list

Definition at line 945 of file translator_fa.h.

945 QCString trTodoList() override

946 {

947 return "ليست کارهاي آينده";

948 }

trType()

QCString TranslatorPersian::trType (bool first_capital, bool singular)

inline virtual

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.

Definition at line 1673 of file translator_fa.h.

1673 QCString trType(bool first_capital, bool singular) override

1674 {

1675 return createNoun(first_capital, singular, "type", "s");

1676 }

Reference Translator::createNoun.

trTypeConstraints()

QCString TranslatorPersian::trTypeConstraints ()

inline virtual

C# Type Constraint list

Definition at line 1689 of file translator_fa.h.

1689 QCString trTypeConstraints() override

1690 {

1691 return "Type Constraints";

1692 }

trTypedefDocumentation()

QCString TranslatorPersian::trTypedefDocumentation ()

inline virtual

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

Definition at line 465 of file translator_fa.h.

465 QCString trTypedefDocumentation() override

466 { return "Typedef"; }

trTypedefs()

QCString TranslatorPersian::trTypedefs ()

inline virtual

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

Definition at line 429 of file translator_fa.h.

429 QCString trTypedefs() override

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

trTypeDocumentation()

QCString TranslatorPersian::trTypeDocumentation ()

inline virtual

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

Definition at line 1558 of file translator_fa.h.

1558 QCString trTypeDocumentation() override

1559 { return "Data Type Documentation"; }

trVariableDocumentation()

QCString TranslatorPersian::trVariableDocumentation ()

inline virtual

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

Definition at line 489 of file translator_fa.h.

489 QCString trVariableDocumentation() override

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

trVariables()

QCString TranslatorPersian::trVariables ()

inline virtual

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

Definition at line 447 of file translator_fa.h.

447 QCString trVariables() override

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

trVersion()

QCString TranslatorPersian::trVersion ()

inline virtual

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

Definition at line 529 of file translator_fa.h.

529 QCString trVersion() override

530 { return "نسخه"; }

trWarning()

QCString TranslatorPersian::trWarning ()

inline virtual

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

Definition at line 525 of file translator_fa.h.

525 QCString trWarning() override

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

trWriteList()

QCString TranslatorPersian::trWriteList (int numEntries)

inline virtual

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

Definition at line 655 of file translator_fa.h.

655 QCString trWriteList(int numEntries) override

656 {

657 QCString result;

658 // the inherits list contain `numEntries' classes

659 for (int i=0;i<numEntries;i++)

660 {

661 // use generateMarker to generate placeholders for the class links!

662 result+=generateMarker(i); // generate marker for entry i in the list

663 // (order is left to right)

664

665 if (i!=numEntries-1) // not the last entry, so we need a separator

666 {

667 if (i<numEntries-2) // not the fore last entry

668 result+=", ";

669 else // the fore last entry

670 result+=" و ";

671 }

672 }

673 return result;

674 }

Reference generateMarker.

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

Private Member Functions

convertDigitsToFarsi()

QCString TranslatorPersian::convertDigitsToFarsi (QCString str)

inline

Converts english digits of an input string to persian equivalents.

Definition at line 47 of file translator_fa.h.

47 QCString convertDigitsToFarsi(QCString str)

48 {

49 QCString output;

50 const char * PersianDigits[] = { "۰", "۱", "۲", "۳", "۴", "۵", "۶", "۷", "۸", "۹" };

51 for(unsigned i=0; i<str.length(); i++)

52 {

53 if (str.at(i) >= '0' && str.at(i) <= '9')

54 output += PersianDigits[ str.at(i) - '0' ];

55 else

56 output += str.at(i);

57 }

58

59 return output;

60 }

References QCString::at and QCString::length.

Referenced by trDateTime.

---

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

• translator_fa.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.