Chameleon

Chameleon Svn Source Tree

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

Archive Download this file

Revision: 1322