Chameleon

Chameleon Svn Source Tree

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

Archive Download this file

Revision: 1322