Chameleon

Chameleon Svn Source Tree

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

Archive Download this file

Revision: 1322