Chameleon

Chameleon Svn Source Tree

Root/branches/xZenu/src/util/doxygen/src/translator_cn.h

Source at commit 1322 created 9 years 5 months ago.
By meklort, Add doxygen to utils folder
1/******************************************************************************
2 *
3 *
4 *
5 * Copyright (C) 1997-2011 by Dimitri van Heesch.
6 *
7 * Permission to use, copy, modify, and distribute this software and its
8 * documentation under the terms of the GNU General Public License is hereby
9 * granted. No representations are made about the suitability of this software
10 * for any purpose. It is provided "as is" without express or implied warranty.
11 * See the GNU General Public License for more details.
12 *
13 * Documents produced by Doxygen are derivative works derived from the
14 * input used in their production; they are not affected by this license.
15 *
16 */
17
18#ifndef TRANSLATOR_CN_H
19#define TRANSLATOR_CN_H
20
21/*!
22 If you want insert a space whenever Chinese meets English charactors, set
23 CN_SPC to " ", else null.
24*/
25#define CN_SPC
26
27class TranslatorChinese : public Translator
28{
29 public:
30/*! Used for identification of the language. The identification
31 * should not be translated. It should be replaced by the name
32 * of the language in English using lower-case characters only
33 * (e.g. "czech", "japanese", "russian", etc.). It sould be equal to
34 * the identification used in the language.cpp.
35 */
36
37 virtual QCString idLanguage()
38 { return "chinese"; }
39
40 /*! Used to get the LaTeX command(s) for the language support.
41 * This method should return string with commands that switch
42 * LaTeX to the desired language. For example
43 * <pre>"\\usepackage[german]{babel}\n"
44 * </pre>
45 * or
46 * <pre>"\\usepackage{polski}\n"
47 * "\\usepackage[latin2]{inputenc}\n"
48 * "\\usepackage[T1]{fontenc}\n"
49 * </pre>
50 *
51 * The English LaTeX does not use such commands. Because of this
52 * the empty string is returned in this implementation.
53 */
54 virtual QCString latexLanguageSupportCommand()
55 {
56 return "";
57 }
58
59
60/*! return the language charset. This will be used for the HTML output */
61 virtual QCString idLanguageCharset()
62 { return "gb2312"; }
63
64/*! used in the compound documentation before a list of related functions.
65 */
66 virtual QCString trRelatedFunctions()
67
68
69/*! subscript for the related functions. */
70 virtual QCString trRelatedSubscript()
71
72
73/*! header that is put before the detailed description of files,
74 * classes and namespaces.
75 */
76 virtual QCString trDetailedDescription()
77
78
79/*! header that is put before the list of typedefs. */
80 virtual QCString trMemberTypedefDocumentation()
81
82
83/*! header that is put before the list of enumerations. */
84 virtual QCString trMemberEnumerationDocumentation()
85
86
87/*! header that is put before the list of member function. */
88 virtual QCString trMemberFunctionDocumentation()
89
90
91/*! header that is put before the list of member attributes. */
92 virtual QCString trMemberDataDocumentation()
93 {
94if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
95{
96
97}
98else {
99
100}
101}
102
103/*! this is the text of a link put after brief descriptions. */
104 virtual QCString trMore()
105
106
107/*! put in the class documention */
108 virtual QCString trListOfAllMembers()
109
110
111/*! used as the title of the "list of all members" page of a class */
112 virtual QCString trMemberList()
113
114
115/*! this is the first part of a sentence that is followed by a class name */
116 virtual QCString trThisIsTheListOfAllMembers()
117
118
119/*! this is the remainder of the sentence after the class name */
120 virtual QCString trIncludingInheritedMembers()
121
122
123/*! this is put at the author sections at the bottom of man pages.
124 * parameter s is name of the project name.
125 */
126 virtual QCString trGeneratedAutomatically(const char *s)
127 {
128QCString result;
129
130
131 return result;
132 }
133
134/*! put after an enum name in the list of all members */
135 virtual QCString trEnumName()
136
137
138/*! put after an enum value in the list of all members */
139 virtual QCString trEnumValue()
140
141
142/*! put after an undocumented member in the list of all members */
143 virtual QCString trDefinedIn()
144
145
146// quick reference sections
147
148
149/*! This is put above each page as a link to the list of all groups of
150 * compounds or files (see the \\group command).
151 */
152 virtual QCString trModules()
153
154
155/*! This is put above each page as a link to the class hierarchy */
156 virtual QCString trClassHierarchy()
157
158
159/*! This is put above each page as a link to the list of annotated class */
160 virtual QCString trCompoundList()
161 {
162if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
163
164}
165else {
166
167}
168}
169
170/*! This is put above each page as a link to the list of documented files */
171 virtual QCString trFileList()
172
173
174/*! This is put above each page as a link to all members of compounds. */
175 virtual QCString trCompoundMembers()
176 {
177if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
178
179}
180else {
181
182}
183}
184
185/*! This is put above each page as a link to all member of files. */
186 virtual QCString trFileMembers()
187 {
188if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
189
190} else {
191
192}
193}
194
195/*! This is put above each page as a link to all related pages. */
196 virtual QCString trRelatedPages()
197
198
199/*! This is put above each page as a link to all examples. */
200 virtual QCString trExamples()
201
202
203 virtual QCString trSearch()
204
205
206 virtual QCString trClassHierarchyDescription()
207
208
209 virtual QCString trFileListDescription(bool extractAll)
210 {
211
212
213
214 return result;
215 }
216
217 virtual QCString trCompoundListDescription()
218 {
219
220if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
221{
222
223}
224else
225{
226
227}
228 }
229
230 virtual QCString trCompoundMembersDescription(bool extractAll)
231 {
232
233 if (!extractAll) {
234
235}
236if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
237
238}
239else {
240
241}
242
243 if (extractAll) {
244if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
245
246}
247else {
248
249}
250}
251 else {
252if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
253
254}
255else {
256
257}
258}
259 return result;
260 }
261
262 virtual QCString trFileMembersDescription(bool extractAll)
263 {
264
265 if (!extractAll)
266
267
268if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
269
270}
271else {
272
273}
274
275 if (extractAll)
276
277 else
278
279 return result;
280 }
281
282 virtual QCString trExamplesDescription()
283
284
285 virtual QCString trRelatedPagesDescription()
286
287
288 virtual QCString trModulesDescription()
289
290
291 virtual QCString trDocumentation()
292
293
294 virtual QCString trModuleIndex()
295
296
297 virtual QCString trHierarchicalIndex()
298
299
300 virtual QCString trCompoundIndex()
301 {
302if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
303{
304
305}
306else {
307
308}
309}
310
311 virtual QCString trFileIndex()
312
313
314 virtual QCString trModuleDocumentation()
315
316
317 virtual QCString trClassDocumentation()
318 {
319if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
320{
321
322}
323else {
324
325}
326}
327
328 virtual QCString trFileDocumentation()
329
330
331 virtual QCString trExampleDocumentation()
332
333
334 virtual QCString trPageDocumentation()
335
336
337 virtual QCString trReferenceManual()
338
339
340 virtual QCString trDefines()
341
342
343 virtual QCString trFuncProtos()
344
345
346 virtual QCString trTypedefs()
347
348
349 virtual QCString trEnumerations()
350
351
352 virtual QCString trFunctions()
353
354
355 virtual QCString trVariables()
356
357
358 virtual QCString trEnumerationValues()
359
360
361
362 virtual QCString trDefineDocumentation()
363
364
365 virtual QCString trFunctionPrototypeDocumentation()
366
367
368 virtual QCString trTypedefDocumentation()
369
370
371 virtual QCString trEnumerationTypeDocumentation()
372
373
374 virtual QCString trFunctionDocumentation()
375
376
377 virtual QCString trVariableDocumentation()
378
379
380 virtual QCString trCompounds()
381 {
382if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
383{
384
385}
386else {
387
388}
389}
390
391 virtual QCString trGeneratedAt(const char *date,const char *projName)
392 {
393 QCString result=(QCString)"Generated at "+date;
394 if (projName) result+=(QCString)" for "+projName;
395 result+=(QCString)" by";
396 return result;
397 }
398
399 virtual QCString trWrittenBy()
400 {
401 return "written by";
402 }
403
404 virtual QCString trClassDiagram(const char *clName)
405 {
406
407 }
408
409 virtual QCString trForInternalUseOnly()
410
411
412 virtual QCString trWarning()
413
414
415 virtual QCString trVersion()
416
417
418 virtual QCString trDate()
419
420
421 virtual QCString trReturns()
422
423
424 virtual QCString trSeeAlso()
425
426
427 virtual QCString trParameters()
428
429
430 virtual QCString trExceptions()
431
432
433 virtual QCString trGeneratedBy()
434
435
436//////////////////////////////////////////////////////////////////////////
437// new since 0.49-990307
438//////////////////////////////////////////////////////////////////////////
439
440 virtual QCString trNamespaceList()
441
442
443 virtual QCString trNamespaceListDescription(bool extractAll)
444 {
445
446
447
448 return result;
449 }
450
451 virtual QCString trFriends()
452
453
454//////////////////////////////////////////////////////////////////////////
455// new since 0.49-990405
456//////////////////////////////////////////////////////////////////////////
457
458 virtual QCString trRelatedFunctionDocumentation()
459
460
461//////////////////////////////////////////////////////////////////////////
462// new since 0.49-990425
463//////////////////////////////////////////////////////////////////////////
464
465 virtual QCString trCompoundReference(const char *clName,
466 ClassDef::CompoundType compType,
467 bool isTemplate)
468 // used as the title of the HTML page of a class/struct/union
469 {
470 QCString result=(QCString)clName;
471
472 switch(compType)
473 {
474
475
476
477
478
479
480
481 }
482
483 return result;
484 }
485
486 virtual QCString trFileReference(const char *fileName)
487 // used as the title of the HTML page of a file
488 {
489 QCString result=fileName;
490
491 return result;
492 }
493
494 virtual QCString trNamespaceReference(const char *namespaceName)
495 // used as the title of the HTML page of a namespace
496 {
497 QCString result=namespaceName;
498
499 return result;
500 }
501
502 // these are for the member sections of a class, struct or union
503 virtual QCString trPublicMembers()
504
505
506 virtual QCString trPublicSlots()
507
508
509 virtual QCString trSignals()
510
511
512 virtual QCString trStaticPublicMembers()
513
514
515 virtual QCString trProtectedMembers()
516
517
518 virtual QCString trProtectedSlots()
519
520
521 virtual QCString trStaticProtectedMembers()
522
523
524 virtual QCString trPrivateMembers()
525
526
527 virtual QCString trPrivateSlots()
528
529
530 virtual QCString trStaticPrivateMembers()
531
532
533 // end of member sections
534
535 virtual QCString trWriteList(int numEntries)
536 {
537 // this function is used to produce a comma-separated list of items.
538 // use generateMarker(i) to indicate where item i should be put.
539 QCString result;
540 int i;
541 // the inherits list contain `numEntries' classes
542 for (i=0;i<numEntries;i++)
543 {
544 // use generateMarker to generate placeholders for the class links!
545 result+=generateMarker(i); // generate marker for entry i in the list
546 // (order is left to right)
547
548 if (i!=numEntries-1) // not the last entry, so we need a separator
549 {
550 if (i<numEntries-2) // not the fore last entry
551
552 else // the fore last entry
553
554 }
555 }
556 return result;
557 }
558
559 virtual QCString trInheritsList(int numEntries)
560 // used in class documentation to produce a list of base classes,
561 // if class diagrams are disabled.
562 {
563
564 }
565
566 virtual QCString trInheritedByList(int numEntries)
567 // used in class documentation to produce a list of super classes,
568 // if class diagrams are disabled.
569 {
570
571 }
572
573 virtual QCString trReimplementedFromList(int numEntries)
574 // used in member documentation blocks to produce a list of
575 // members that are hidden by this one.
576 {
577
578 }
579
580 virtual QCString trReimplementedInList(int numEntries)
581 {
582 // used in member documentation blocks to produce a list of
583 // all member that overwrite the implementation of this member.
584
585 }
586
587 virtual QCString trNamespaceMembers()
588 // This is put above each page as a link to all members of namespaces.
589
590
591 virtual QCString trNamespaceMemberDescription(bool extractAll)
592 // This is an introduction to the page with all namespace members
593 {
594
595
596
597 if (extractAll)
598
599 else
600
601 return result;
602 }
603
604 virtual QCString trNamespaceIndex()
605 // This is used in LaTeX as the title of the chapter with the
606 // index of all namespaces.
607
608
609 virtual QCString trNamespaceDocumentation()
610 // This is used in LaTeX as the title of the chapter containing
611 // the documentation of all namespaces.
612
613
614//////////////////////////////////////////////////////////////////////////
615// new since 0.49-990522
616//////////////////////////////////////////////////////////////////////////
617
618 /*! This is used in the documentation before the list of all
619 * namespaces in a file.
620 */
621 virtual QCString trNamespaces()
622 {
623 // return "Namespaces";
624
625 }
626
627//////////////////////////////////////////////////////////////////////////
628// new since 0.49-990728
629//////////////////////////////////////////////////////////////////////////
630
631 /*! This is put at the bottom of a class documentation page and is
632 * followed by a list of files that were used to generate the page.
633 */
634 virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType,
635 bool)
636 { // here s is one of " Class", " Struct" or " Union"
637 // single is true implies a single file
638
639 switch(compType)
640 {
641
642
643
644
645
646
647
648 }
649
650 return result;
651 }
652
653 /*! This is in the (quick) index as a link to the alphabetical compound
654 * list.
655 */
656 virtual QCString trAlphabeticalList()
657
658
659//////////////////////////////////////////////////////////////////////////
660// new since 0.49-990901
661//////////////////////////////////////////////////////////////////////////
662
663 /*! This is used as the heading text for the retval command. */
664 virtual QCString trReturnValues()
665
666
667 /*! This is in the (quick) index as a link to the main page (index.html)
668 */
669 virtual QCString trMainPage()
670
671
672 /*! This is used in references to page that are put in the LaTeX
673 * documentation. It should be an abbreviation of the word page.
674 */
675 virtual QCString trPageAbbreviation()
676 { return "p."; }
677
678//////////////////////////////////////////////////////////////////////////
679// new since 0.49-991106
680//////////////////////////////////////////////////////////////////////////
681
682 virtual QCString trDefinedAtLineInSourceFile()
683 {
684
685 }
686
687 virtual QCString trDefinedInSourceFile()
688 {
689
690 }
691
692//////////////////////////////////////////////////////////////////////////
693// new since 0.49-991205
694//////////////////////////////////////////////////////////////////////////
695
696 virtual QCString trDeprecated()
697 {
698 return "Deprecated";
699 }
700
701//////////////////////////////////////////////////////////////////////////
702// new since 1.0.0
703//////////////////////////////////////////////////////////////////////////
704
705 /*! this text is put before a collaboration diagram */
706 virtual QCString trCollaborationDiagram(const char *clName)
707 {
708
709 }
710
711 /*! this text is put before an include dependency graph */
712 virtual QCString trInclDepGraph(const char *fName)
713 {
714
715 }
716
717 /*! header that is put before the list of constructor/destructors. */
718 virtual QCString trConstructorDocumentation()
719 {
720
721 }
722
723 /*! Used in the file documentation to point to the corresponding sources. */
724 virtual QCString trGotoSourceCode()
725 {
726
727 }
728
729 /*! Used in the file sources to point to the corresponding documentation. */
730 virtual QCString trGotoDocumentation()
731 {
732
733 }
734
735 /*! Text for the \\pre command */
736 virtual QCString trPrecondition()
737 {
738
739 }
740
741 /*! Text for the \\post command */
742 virtual QCString trPostcondition()
743 {
744
745 }
746
747 /*! Text for the \\invariant command */
748 virtual QCString trInvariant()
749 {
750
751 }
752
753 /*! Text shown before a multi-line variable/enum initialization */
754 virtual QCString trInitialValue()
755 {
756
757 }
758
759 /*! Text used the source code in the file index */
760 virtual QCString trCode()
761 {
762
763 }
764
765 virtual QCString trGraphicalHierarchy()
766 {
767
768 }
769
770 virtual QCString trGotoGraphicalHierarchy()
771 {
772
773 }
774
775 virtual QCString trGotoTextualHierarchy()
776 {
777
778 }
779
780 virtual QCString trPageIndex()
781 {
782
783 }
784
785//////////////////////////////////////////////////////////////////////////
786// new since 1.1.0
787//////////////////////////////////////////////////////////////////////////
788
789 virtual QCString trNote()
790 {
791
792 }
793
794 virtual QCString trPublicTypes()
795 {
796
797 }
798
799 virtual QCString trPublicAttribs()
800 {
801 if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
802 {
803
804 }
805 else {
806
807 }
808 }
809
810 virtual QCString trStaticPublicAttribs()
811 {
812
813 }
814
815 virtual QCString trProtectedTypes()
816 {
817
818 }
819
820 virtual QCString trProtectedAttribs()
821 {
822
823 }
824
825 virtual QCString trStaticProtectedAttribs()
826 {
827
828 }
829
830 virtual QCString trPrivateTypes()
831 {
832
833 }
834
835 virtual QCString trPrivateAttribs()
836 {
837
838 }
839
840 virtual QCString trStaticPrivateAttribs()
841 {
842
843 }
844
845
846//////////////////////////////////////////////////////////////////////////
847// new since 1.1.3
848//////////////////////////////////////////////////////////////////////////
849
850 /*! Used as a marker that is put before a todo item */
851 virtual QCString trTodo()
852 {
853 return "TODO";
854 }
855
856 /*! Used as the header of the todo list */
857 virtual QCString trTodoList()
858 {
859
860 }
861
862//////////////////////////////////////////////////////////////////////////
863// new since 1.1.4
864//////////////////////////////////////////////////////////////////////////
865
866 virtual QCString trReferencedBy()
867 {
868
869 }
870
871 virtual QCString trRemarks()
872 {
873
874 }
875
876 virtual QCString trAttention()
877 {
878
879 }
880
881 virtual QCString trInclByDepGraph()
882 {
883
884 }
885
886 virtual QCString trSince()
887 {
888
889 }
890
891//////////////////////////////////////////////////////////////////////////
892// new since 1.1.5
893//////////////////////////////////////////////////////////////////////////
894
895 /*! title of the graph legend page */
896 virtual QCString trLegendTitle()
897 {
898
899 }
900
901 /*! page explaining how the dot graph's should be interpreted */
902 virtual QCString trLegendDocs()
903 {
904 return
905
906
907 "\\code\n"
908
909 "class Invisible { };\n\n"
910
911 "class Truncated : public Invisible { };\n\n"
912
913 "class Undocumented { };\n\n"
914
915 "class PublicBase : public Truncated { };\n\n"
916 "/*! A template class */\n"
917 "template<class T> class Templ { };\n\n"
918
919 "class ProtectedBase { };\n\n"
920
921 "class PrivateBase { };\n\n"
922
923 "class Used { };\n\n"
924
925 "class Inherited : public PublicBase,\n"
926 " protected ProtectedBase,\n"
927 " private PrivateBase,\n"
928 " public Undocumented,\n"
929 " public Templ<int>\n"
930 "{\n"
931 " private:\n"
932 " Used *m_usedClass;\n"
933 "};\n"
934 "\\endcode\n"
935
936
937 "<p><center><img src=\"graph_legend."+Config_getEnum("DOT_IMAGE_FORMAT")+"\"></center>\n"
938 "<p>\n"
939
940 "<ul>\n"
941
942
943
944
945
946 "</ul>\n"
947
948 "<ul>\n"
949
950
951
952
953
954 "</ul>\n";
955 }
956 /*! text for the link to the legend page */
957 virtual QCString trLegend()
958 {
959
960 }
961
962//////////////////////////////////////////////////////////////////////////
963// new since 1.2.0
964//////////////////////////////////////////////////////////////////////////
965
966 /*! Used as a marker that is put before a test item */
967 virtual QCString trTest()
968 {
969
970 }
971
972 /*! Used as the header of the test list */
973 virtual QCString trTestList()
974 {
975
976 }
977
978//////////////////////////////////////////////////////////////////////////
979//// new since 1.2.1
980////////////////////////////////////////////////////////////////////////////
981/*! Used as a section header for KDE-2 IDL methods */
982virtual QCString trDCOPMethods()
983{
984
985}
986
987//////////////////////////////////////////////////////////////////////////
988//// new since 1.2.2
989////////////////////////////////////////////////////////////////////////////
990
991/*! Used as a section header for IDL properties */
992virtual QCString trProperties()
993{
994
995}
996
997/*! Used as a section header for IDL property documentation */
998virtual QCString trPropertyDocumentation()
999{
1000
1001}
1002
1003//////////////////////////////////////////////////////////////////////////
1004// new since 1.2.4
1005//////////////////////////////////////////////////////////////////////////
1006
1007 /*! Used for Java classes in the summary section of Java packages */
1008 virtual QCString trClasses()
1009 {
1010if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
1011{
1012
1013}
1014else
1015{
1016
1017}
1018 }
1019
1020 /*! Used as the title of a Java package */
1021 virtual QCString trPackage(const char *name)
1022 {
1023
1024 }
1025
1026 /*! Title of the package index page */
1027 virtual QCString trPackageList()
1028 {
1029
1030 }
1031
1032 /*! The description of the package index page */
1033 virtual QCString trPackageListDescription()
1034 {
1035
1036 }
1037
1038 /*! The link name in the Quick links header for each page */
1039 virtual QCString trPackages()
1040 {
1041
1042 }
1043
1044 /*! Text shown before a multi-line define */
1045 virtual QCString trDefineValue()
1046 {
1047 return "ֵ:";
1048 }
1049
1050////////////////////////////////////////////////////////////////////////////
1051//// new since 1.2.6
1052////////////////////////////////////////////////////////////////////////////
1053virtual QCString trBug ()
1054{
1055
1056}
1057
1058virtual QCString trBugList ()
1059{
1060
1061}
1062
1063//////////////////////////////////////////////////////////////////////////
1064// new since 1.2.6
1065//////////////////////////////////////////////////////////////////////////
1066
1067 /*! Used as ansicpg for RTF file
1068 *
1069 * The following table shows the correlation of Charset name, Charset Value and
1070 * <pre>
1071 * Codepage number:
1072 * Charset Name Charset Value(hex) Codepage number
1073 * ------------------------------------------------------
1074 * DEFAULT_CHARSET 1 (x01)
1075 * SYMBOL_CHARSET 2 (x02)
1076 * OEM_CHARSET 255 (xFF)
1077 * ANSI_CHARSET 0 (x00) 1252
1078 * RUSSIAN_CHARSET 204 (xCC) 1251
1079 * EE_CHARSET 238 (xEE) 1250
1080 * GREEK_CHARSET 161 (xA1) 1253
1081 * TURKISH_CHARSET 162 (xA2) 1254
1082 * BALTIC_CHARSET 186 (xBA) 1257
1083 * HEBREW_CHARSET 177 (xB1) 1255
1084 * ARABIC _CHARSET 178 (xB2) 1256
1085 * SHIFTJIS_CHARSET 128 (x80) 932
1086 * HANGEUL_CHARSET 129 (x81) 949
1087 * GB2313_CHARSET 134 (x86) 936
1088 * CHINESEBIG5_CHARSET 136 (x88) 950
1089 * </pre>
1090 *
1091 */
1092 virtual QCString trRTFansicp()
1093 {
1094 return "936";
1095 }
1096
1097 /*! Used as ansicpg for RTF fcharset
1098 * \see trRTFansicp() for a table of possible values.
1099 */
1100 virtual QCString trRTFCharSet()
1101 {
1102 return "134";
1103 }
1104
1105
1106 /*! Used as header RTF general index */
1107 virtual QCString trRTFGeneralIndex()
1108 {
1109
1110 }
1111
1112
1113 /*! This is used for translation of the word that will possibly
1114 * be followed by a single name or by a list of names
1115 * of the category.
1116 */
1117 virtual QCString trClass(bool /*first_capital*/, bool /*singular*/)
1118 {
1119/*
1120 QCString result((first_capital ? "Class" : "class"));
1121 if (!singular) result+="es";
1122 return result;
1123*/
1124
1125 }
1126
1127 /*! This is used for translation of the word that will possibly
1128 * be followed by a single name or by a list of names
1129 * of the category.
1130 */
1131 virtual QCString trFile(bool /*first_capital*/, bool /*singular*/)
1132 {
1133/*
1134 QCString result((first_capital ? "File" : "file"));
1135 if (!singular) result+="s";
1136 return result;
1137*/
1138
1139
1140 }
1141
1142 /*! This is used for translation of the word that will possibly
1143 * be followed by a single name or by a list of names
1144 * of the category.
1145 */
1146 virtual QCString trNamespace(bool /*first_capital*/, bool /*singular*/)
1147 {
1148/*
1149 QCString result((first_capital ? "Namespace" : "namespace"));
1150 if (!singular) result+="s";
1151 return result;
1152*/
1153
1154 }
1155
1156 /*! This is used for translation of the word that will possibly
1157 * be followed by a single name or by a list of names
1158 * of the category.
1159 */
1160 virtual QCString trGroup(bool /*first_capital*/, bool /*singular*/)
1161 {
1162/*
1163 QCString result((first_capital ? "Group" : "group"));
1164 if (!singular) result+="s";
1165 return result;
1166*/
1167
1168 }
1169
1170 /*! This is used for translation of the word that will possibly
1171 * be followed by a single name or by a list of names
1172 * of the category.
1173 */
1174 virtual QCString trPage(bool /*first_capital*/, bool /*singular*/)
1175 {
1176/*
1177 QCString result((first_capital ? "Page" : "page"));
1178 if (!singular) result+="s";
1179 return result;
1180*/
1181return "ҳ";
1182 }
1183
1184 /*! This is used for translation of the word that will possibly
1185 * be followed by a single name or by a list of names
1186 * of the category.
1187 */
1188 virtual QCString trMember(bool /*first_capital*/, bool /*singular*/)
1189 {
1190/*
1191 QCString result((first_capital ? "Member" : "member"));
1192 if (!singular) result+="s";
1193 return result;
1194*/
1195
1196 }
1197
1198 /*! This is used for translation of the word that will possibly
1199 * be followed by a single name or by a list of names
1200 * of the category.
1201 */
1202 virtual QCString trGlobal(bool /*first_capital*/, bool /*singular*/)
1203 {
1204/*
1205 QCString result((first_capital ? "Global" : "global"));
1206 if (!singular) result+="s";
1207 return result;
1208*/
1209
1210 }
1211
1212//////////////////////////////////////////////////////////////////////////
1213// new since 1.2.7
1214//////////////////////////////////////////////////////////////////////////
1215
1216 /*! This text is generated when the \\author command is used and
1217 * for the author section in man pages. */
1218 virtual QCString trAuthor(bool /*first_capital*/, bool /*singular*/)
1219 {
1220/*
1221 QCString result((first_capital ? "Author" : "author"));
1222 if (!singular) result+="s";
1223 return result;
1224*/
1225
1226 }
1227
1228//////////////////////////////////////////////////////////////////////////
1229// new since 1.2.11
1230//////////////////////////////////////////////////////////////////////////
1231
1232 /*! This text is put before the list of members referenced by a member
1233 */
1234 virtual QCString trReferences()
1235 {
1236
1237 }
1238
1239//////////////////////////////////////////////////////////////////////////
1240// new since 1.2.13
1241//////////////////////////////////////////////////////////////////////////
1242
1243 /*! used in member documentation blocks to produce a list of
1244 * members that are implemented by this one.
1245 */
1246 virtual QCString trImplementedFromList(int numEntries)
1247 {
1248 /* return "Implements "+trWriteList(numEntries)+"."; */
1249
1250 }
1251
1252 /*! used in member documentation blocks to produce a list of
1253 * all members that implement this abstract member.
1254 */
1255 virtual QCString trImplementedInList(int numEntries)
1256 {
1257 /* return "Implemented in "+trWriteList(numEntries)+"."; */
1258
1259 }
1260
1261//////////////////////////////////////////////////////////////////////////
1262// new since 1.2.16
1263//////////////////////////////////////////////////////////////////////////
1264
1265 /*! used in RTF documentation as a heading for the Table
1266 * of Contents.
1267 */
1268 virtual QCString trRTFTableOfContents()
1269 {
1270 /* return "Table of Contents"; */
1271 return "Ŀ¼";
1272 }
1273
1274//////////////////////////////////////////////////////////////////////////
1275// new since 1.2.17
1276//////////////////////////////////////////////////////////////////////////
1277
1278 /*! Used as the header of the list of item that have been
1279 * flagged deprecated
1280 */
1281 virtual QCString trDeprecatedList()
1282 {
1283/* return "Deprecated List"; */
1284
1285 }
1286
1287//////////////////////////////////////////////////////////////////////////
1288// new since 1.2.18
1289//////////////////////////////////////////////////////////////////////////
1290
1291 /*! Used as a header for declaration section of the events found in
1292 * a C# program
1293 */
1294 virtual QCString trEvents()
1295 {
1296 /* return "Events"; */
1297
1298 }
1299 /*! Header used for the documentation section of a class' events. */
1300 virtual QCString trEventDocumentation()
1301 {
1302 /* return "Event Documentation"; */
1303
1304 }
1305
1306//////////////////////////////////////////////////////////////////////////
1307// new since 1.3
1308//////////////////////////////////////////////////////////////////////////
1309
1310 /*! Used as a heading for a list of Java class types with package scope.
1311 */
1312 virtual QCString trPackageTypes()
1313 {
1314 /* return "Package Types"; */
1315
1316 }
1317 /*! Used as a heading for a list of Java class functions with package
1318 * scope.
1319 */
1320 virtual QCString trPackageMembers()
1321 {
1322 /* return "Package Functions"; */
1323
1324 }
1325 /*! Used as a heading for a list of static Java class functions with
1326 * package scope.
1327 */
1328 virtual QCString trStaticPackageMembers()
1329 {
1330 /* return "Static Package Functions"; */
1331
1332 }
1333 /*! Used as a heading for a list of Java class variables with package
1334 * scope.
1335 */
1336 virtual QCString trPackageAttribs()
1337 {
1338 /* return "Package Attributes"; */
1339
1340 }
1341 /*! Used as a heading for a list of static Java class variables with
1342 * package scope.
1343 */
1344 virtual QCString trStaticPackageAttribs()
1345 {
1346 /* return "Static Package Attributes"; */
1347
1348 }
1349
1350//////////////////////////////////////////////////////////////////////////
1351// new since 1.3.1
1352//////////////////////////////////////////////////////////////////////////
1353
1354 /*! Used in the quick index of a class/file/namespace member list page
1355 * to link to the unfiltered list of all members.
1356 */
1357 virtual QCString trAll()
1358 {
1359 /* return "All"; */
1360
1361 }
1362 /*! Put in front of the call graph for a function. */
1363 virtual QCString trCallGraph()
1364 {
1365 /* return "Here is the call graph for this function:"; */
1366
1367 }
1368
1369//////////////////////////////////////////////////////////////////////////
1370// new since 1.3.3
1371//////////////////////////////////////////////////////////////////////////
1372
1373 /*! When the search engine is enabled this text is put in the header
1374 * of each page before the field where one can enter the text to search
1375 * for.
1376 */
1377 virtual QCString trSearchForIndex()
1378 {
1379 /* return "Search for"; */
1380
1381 }
1382 /*! This string is used as the title for the page listing the search
1383 * results.
1384 */
1385 virtual QCString trSearchResultsTitle()
1386 {
1387 /* return "Search Results"; */
1388
1389 }
1390 /*! This string is put just before listing the search results. The
1391 * text can be different depending on the number of documents found.
1392 * Inside the text you can put the special marker $num to insert
1393 * the number representing the actual number of search results.
1394 * The @a numDocuments parameter can be either 0, 1 or 2, where the
1395 * value 2 represents 2 or more matches. HTML markup is allowed inside
1396 * the returned string.
1397 */
1398 virtual QCString trSearchResults(int numDocuments)
1399 {
1400 if (numDocuments==0)
1401 {
1402 /* return "Sorry, no documents matching your query."; */
1403
1404 }
1405 else if (numDocuments==1)
1406 {
1407 /* return "Found <b>1</b> document matching your query."; */
1408
1409 }
1410 else
1411 {
1412 /* return "Found <b>$num</b> documents matching your query. "
1413 "Showing best matches first."; */
1414
1415
1416 }
1417 }
1418 /*! This string is put before the list of matched words, for each search
1419 * result. What follows is the list of words that matched the query.
1420 */
1421 virtual QCString trSearchMatches()
1422 {
1423 /* return "Matches:"; */
1424
1425 }
1426
1427//////////////////////////////////////////////////////////////////////////
1428// new since 1.3.8
1429//////////////////////////////////////////////////////////////////////////
1430
1431 /*! This is used in HTML as the title of page with source code for file filename
1432 */
1433 virtual QCString trSourceFile(QCString& filename)
1434 {
1435 /* return filename + " Source File"; */
1436
1437 }
1438//////////////////////////////////////////////////////////////////////////
1439// new since 1.3.9
1440//////////////////////////////////////////////////////////////////////////
1441
1442 /*! This is used as the name of the chapter containing the directory
1443 * hierarchy.
1444 */
1445 virtual QCString trDirIndex()
1446 /* { return "Directory Hierarchy"; } */
1447 {
1448
1449 }
1450
1451 /*! This is used as the name of the chapter containing the documentation
1452 * of the directories.
1453 */
1454 virtual QCString trDirDocumentation()
1455 /* { return "Directory Documentation"; } */
1456 {
1457
1458 }
1459
1460 /*! This is used as the title of the directory index and also in the
1461 * Quick links of a HTML page, to link to the directory hierarchy.
1462 */
1463 virtual QCString trDirectories()
1464 /* { return "Directories"; } */
1465 {
1466 return "Ŀ¼";
1467 }
1468
1469 /*! This returns a sentences that introduces the directory hierarchy.
1470 * and the fact that it is sorted alphabetically per level
1471 */
1472 virtual QCString trDirDescription()
1473/* { return "This directory hierarchy is sorted roughly, " */
1474/* "but not completely, alphabetically:"; */
1475/* } */
1476 {
1477
1478 }
1479
1480 /*! This returns the title of a directory page. The name of the
1481 * directory is passed via \a dirName.
1482 */
1483 virtual QCString trDirReference(const char *dirName)
1484 /* { QCString result=dirName; result+=" Directory Reference"; return result; } */
1485 {
1486 QCString result=dirName;
1487
1488 return result;
1489 }
1490
1491 /*! This returns the word directory with or without starting capital
1492 * (\a first_capital) and in sigular or plural form (\a singular).
1493 */
1494 virtual QCString trDir(bool, bool)
1495 {
1496 /* QCString result((first_capital ? "Director" : "director")); */
1497 /* if (singular) result+="y"; else result+="ies"; */
1498 /* return result; */
1499 return "Ŀ¼";
1500 }
1501
1502//////////////////////////////////////////////////////////////////////////
1503// new since 1.4.1
1504//////////////////////////////////////////////////////////////////////////
1505
1506 /*! This text is added to the documentation when the \\overload command
1507 * is used for a overloaded function.
1508 */
1509 virtual QCString trOverloadText()
1510 {
1511 /* return "This is an overloaded member function, "
1512 "provided for convenience. It differs from the above "
1513 "function only in what argument(s) it accepts."; */
1514
1515
1516 }
1517
1518//////////////////////////////////////////////////////////////////////////
1519// new since 1.4.6
1520//////////////////////////////////////////////////////////////////////////
1521
1522 /*! This is used to introduce a caller (or called-by) graph */
1523 virtual QCString trCallerGraph()
1524 {
1525 /* return "Here is the caller graph for this function:"; */
1526
1527 }
1528
1529 /*! This is used in the documentation of a file/namespace before the list
1530 * of documentation blocks for enumeration values
1531 */
1532 virtual QCString trEnumerationValueDocumentation()
1533 {
1534 /* return "Enumerator Documentation"; */
1535
1536 }
1537
1538//////////////////////////////////////////////////////////////////////////
1539// new since 1.5.4 (mainly for Fortran)
1540//////////////////////////////////////////////////////////////////////////
1541
1542 /*! header that is put before the list of member subprograms (Fortran). */
1543 virtual QCString trMemberFunctionDocumentationFortran()
1544 // { return "Member Function/Subroutine Documentation"; }
1545
1546
1547 /*! This is put above each page as a link to the list of annotated data types (Fortran). */
1548 virtual QCString trCompoundListFortran()
1549 // { return "Data Types List"; }
1550
1551
1552 /*! This is put above each page as a link to all members of compounds (Fortran). */
1553 virtual QCString trCompoundMembersFortran()
1554 // { return "Data Fields"; }
1555
1556
1557 /*! This is an introduction to the annotated compound list (Fortran). */
1558 virtual QCString trCompoundListDescriptionFortran()
1559 // { return "Here are the data types with brief descriptions:"; }
1560
1561
1562 /*! This is an introduction to the page with all data types (Fortran). */
1563 virtual QCString trCompoundMembersDescriptionFortran(bool extractAll)
1564 {
1565 // QCString result="Here is a list of all ";
1566 // if (!extractAll)
1567 // {
1568 // result+="documented ";
1569 // }
1570 // result+="data types members";
1571 // result+=" with links to ";
1572 // if (!extractAll)
1573 // {
1574 // result+="the data structure documentation for each member";
1575 // }
1576 // else
1577 // {
1578 // result+="the data types they belong to:";
1579 // }
1580 // return result;
1581 if(!extractAll) {
1582
1583 } else {
1584
1585 }
1586
1587 }
1588
1589 /*! This is used in LaTeX as the title of the chapter with the
1590 * annotated compound index (Fortran).
1591 */
1592 virtual QCString trCompoundIndexFortran()
1593 // { return "Data Type Index"; }
1594
1595
1596
1597 /*! This is used in LaTeX as the title of the chapter containing
1598 * the documentation of all data types (Fortran).
1599 */
1600 virtual QCString trTypeDocumentation()
1601 // { return "Data Type Documentation"; }
1602
1603
1604 /*! This is used in the documentation of a file as a header before the
1605 * list of (global) subprograms (Fortran).
1606 */
1607 virtual QCString trSubprograms()
1608 //{ return "Functions/Subroutines"; }
1609
1610
1611 /*! This is used in the documentation of a file/namespace before the list
1612 * of documentation blocks for subprograms (Fortran)
1613 */
1614 virtual QCString trSubprogramDocumentation()
1615 //{ return "Function/Subroutine Documentation"; }
1616
1617
1618
1619 /*! This is used in the documentation of a file/namespace/group before
1620 * the list of links to documented compounds (Fortran)
1621 */
1622 virtual QCString trDataTypes()
1623 // { return "Data Types"; }
1624
1625
1626 /*! used as the title of page containing all the index of all modules (Fortran). */
1627 virtual QCString trModulesList()
1628 // { return "Modules List"; }
1629
1630
1631 /*! used as an introduction to the modules list (Fortran) */
1632 virtual QCString trModulesListDescription(bool extractAll)
1633 {
1634 // QCString result="Here is a list of all ";
1635 // if (!extractAll) result+="documented ";
1636 // result+="modules with brief descriptions:";
1637 // return result;
1638 if(!extractAll) {
1639
1640 } else {
1641
1642 }
1643 }
1644
1645 /*! used as the title of the HTML page of a module/type (Fortran) */
1646 virtual QCString trCompoundReferenceFortran(const char *clName,
1647 ClassDef::CompoundType compType,
1648 bool isTemplate)
1649 {
1650 // QCString result=(QCString)clName;
1651 // switch(compType)
1652 // {
1653 // case ClassDef::Class: result+=" Module"; break;
1654 // case ClassDef::Struct: result+=" Type"; break;
1655 // case ClassDef::Union: result+=" Union"; break;
1656 // case ClassDef::Interface: result+=" Interface"; break;
1657 // case ClassDef::Protocol: result+=" Protocol"; break;
1658 // case ClassDef::Category: result+=" Category"; break;
1659 // case ClassDef::Exception: result+=" Exception"; break;
1660 // }
1661 // if (isTemplate) result+=" Template";
1662 // result+=" Reference";
1663 // return result;
1664 QCString result=(QCString)clName;
1665 switch(compType)
1666 {
1667
1668
1669
1670
1671
1672 case ClassDef::Category: result+=CN_SPC"Ŀ¼"; break;
1673
1674 }
1675
1676
1677 return result;
1678 }
1679 /*! used as the title of the HTML page of a module (Fortran) */
1680 virtual QCString trModuleReference(const char *namespaceName)
1681 {
1682 QCString result=namespaceName;
1683 // result+=" Module Reference";
1684
1685 return result;
1686 }
1687
1688 /*! This is put above each page as a link to all members of modules. (Fortran) */
1689 virtual QCString trModulesMembers()
1690 // { return "Module Members"; }
1691
1692
1693 /*! This is an introduction to the page with all modules members (Fortran) */
1694 virtual QCString trModulesMemberDescription(bool extractAll)
1695 {
1696 // QCString result="Here is a list of all ";
1697 // if (!extractAll) result+="documented ";
1698 // result+="module members with links to ";
1699 // if (extractAll)
1700 // {
1701 // result+="the module documentation for each member:";
1702 // }
1703 // else
1704 // {
1705 // result+="the modules they belong to:";
1706 // }
1707 // return result;
1708 if(!extractAll) {
1709
1710 } else {
1711
1712 }
1713 }
1714
1715 /*! This is used in LaTeX as the title of the chapter with the
1716 * index of all modules (Fortran).
1717 */
1718 virtual QCString trModulesIndex()
1719 // { return "Modules Index"; }
1720
1721
1722 /*! This is used for translation of the word that will possibly
1723 * be followed by a single name or by a list of names
1724 * of the category.
1725 */
1726 virtual QCString trModule(bool, bool)
1727 {
1728 // QCString result((first_capital ? "Module" : "module"));
1729 // if (!singular) result+="s";
1730 // return result;
1731
1732 }
1733 /*! This is put at the bottom of a module documentation page and is
1734 * followed by a list of files that were used to generate the page.
1735 */
1736 virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType,
1737 bool)
1738 { // here s is one of " Module", " Struct" or " Union"
1739 // single is true implies a single file
1740 // QCString result=(QCString)"The documentation for this ";
1741 // switch(compType)
1742 // {
1743 // case ClassDef::Class: result+="module"; break;
1744 // case ClassDef::Struct: result+="type"; break;
1745 // case ClassDef::Union: result+="union"; break;
1746 // case ClassDef::Interface: result+="interface"; break;
1747 // case ClassDef::Protocol: result+="protocol"; break;
1748 // case ClassDef::Category: result+="category"; break;
1749 // case ClassDef::Exception: result+="exception"; break;
1750 // }
1751 // result+=" was generated from the following file";
1752 // if (single) result+=":"; else result+="s:";
1753 // return result;
1754
1755 switch(compType)
1756 {
1757
1758
1759
1760
1761
1762 case ClassDef::Category: result+=CN_SPC"Ŀ¼"; break;
1763
1764 }
1765
1766 return result;
1767 }
1768 /*! This is used for translation of the word that will possibly
1769 * be followed by a single name or by a list of names
1770 * of the category.
1771 */
1772 virtual QCString trType(bool, bool)
1773 {
1774
1775 }
1776 /*! This is used for translation of the word that will possibly
1777 * be followed by a single name or by a list of names
1778 * of the category.
1779 */
1780 virtual QCString trSubprogram(bool, bool)
1781 {
1782
1783 }
1784
1785 /*! C# Type Constraint list */
1786 virtual QCString trTypeConstraints()
1787 {
1788
1789 }
1790
1791//////////////////////////////////////////////////////////////////////////
1792// new since 1.6.0
1793//////////////////////////////////////////////////////////////////////////
1794virtual QCString trDirRelation(const char *name)
1795{
1796// return QCString(name)+" Relation";
1797// unsure
1798
1799}
1800
1801 virtual QCString trLoading()
1802{
1803
1804}
1805
1806virtual QCString trGlobalNamespace()
1807{
1808
1809}
1810
1811 virtual QCString trSearching()
1812{
1813
1814}
1815
1816virtual QCString trNoMatches()
1817{
1818
1819}
1820
1821//////////////////////////////////////////////////////////////////////////
1822// new since 1.6.3
1823//////////////////////////////////////////////////////////////////////////
1824
1825 virtual QCString trDirDependency(const char *name)
1826{
1827// return (QCString)"Directory dependency graph for "+name;
1828// unsure
1829
1830}
1831
1832virtual QCString trFileIn(const char *name)
1833{
1834// return (QCString)"File in "+name;
1835// unsure
1836
1837}
1838
1839 virtual QCString trIncludesFileIn(const char *name)
1840{
1841// return (QCString)"Includes file in "+name;
1842// unsure
1843
1844}
1845
1846 virtual QCString trDateTime(int year,int month,int day,int dayOfWeek,
1847 int hour,int minutes,int seconds,
1848 bool includeTime)
1849{
1850
1851
1852
1853 QCString sdate;
1854
1855
1856
1857 if (includeTime)
1858 {
1859 QCString stime;
1860 stime.sprintf(" %.2d:%.2d:%.2d",hour,minutes,seconds);
1861 sdate+=stime;
1862 }
1863 return sdate;
1864}
1865};
1866
1867#endif
1868
1869

Archive Download this file

Revision: 1322