Doxygen
Loading...
Searching...
No Matches
translator_en.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2026 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15
16#ifndef TRANSLATOR_EN_H
17#define TRANSLATOR_EN_H
18
19/*!
20 When defining a translator class for the new language, follow
21 the description in the documentation. One of the steps says
22 that you should copy the translator_en.h (this) file to your
23 translator_xx.h new file. Your new language should use the
24 Translator class as the base class. This means that you need to
25 implement exactly the same (pure virtual) override methods as the
26 TranslatorEnglish does. Because of this, it is a good idea to
27 start with the copy of TranslatorEnglish and replace the strings
28 one by one.
29
30 It is not necessary to include "translator.h" or
31 "translator_adapter.h" here. The files are included in the
32 language.cpp correctly. Not including any of the mentioned
33 files frees the maintainer from thinking about whether the
34 first, the second, or both files should be included or not, and
35 why. This holds namely for localized translators because their
36 base class is changed occasionally to adapter classes when the
37 Translator class changes the interface, or back to the
38 Translator class (by the local maintainer) when the localized
39 translator is made up-to-date again.
40*/
42{
43 public:
44
45 // --- Language control methods -------------------
46
47 /*! Used for identification of the language. The identification
48 * should not be translated. It should be replaced by the name
49 * of the language in English using lower-case characters only
50 * (e.g. "czech", "japanese", "russian", etc.). It should be equal to
51 * the identification used in language.cpp.
52 */
54 { return "english"; }
55
56 /*! Used to get the LaTeX command(s) for the language support.
57 * This method should return string with commands that switch
58 * LaTeX to the desired language. For example
59 * <pre>"\\usepackage[german]{babel}\n"
60 * </pre>
61 * or
62 * <pre>"\\usepackage{polski}\n"
63 * "\\usepackage[latin2]{inputenc}\n"
64 * "\\usepackage[T1]{fontenc}\n"
65 * </pre>
66 *
67 * The English LaTeX does not use such commands. Because of this
68 * the empty string is returned in this implementation.
69 */
71 {
72 return "";
73 }
74
75 DString trISOLang() override
76 {
77 return "en-US";
78 }
79
81 {
82 return "0x409 English (United States)";
83 }
84 // --- Language translation methods -------------------
85
86 /*! used in the compound documentation before a list of related functions. */
88 { return "Related Functions"; }
89
90 /*! subscript for the related functions. */
92 { return "(Note that these are not member functions.)"; }
93
94 /*! header that is put before the detailed description of files, classes and namespaces. */
96 { return "Detailed Description"; }
97
98 /*! header that is used when the summary tag is missing inside the details tag */
99 DString trDetails() override
100 { return "Details"; }
101
102 /*! header that is put before the list of typedefs. */
104 { return "Member Typedef Documentation"; }
105
106 /*! header that is put before the list of enumerations. */
108 { return "Member Enumeration Documentation"; }
109
110 /*! header that is put before the list of member functions. */
112 {
113 if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
114 {
115 return "Member Function/Procedure/Process Documentation";
116 }
117 else
118 {
119 return "Member Function Documentation";
120 }
121 }
122
123 /*! header that is put before the list of member attributes. */
125 {
126 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
127 {
128 return "Field Documentation";
129 }
130 else
131 {
132 return "Member Data Documentation";
133 }
134 }
135
136 /*! this is the text of a link put after brief descriptions. */
137 DString trMore() override
138 { return "More..."; }
139
140 /*! put in the class documentation */
142 { return "List of all members"; }
143
144 /*! used as the title of the "list of all members" page of a class */
146 { return "Member List"; }
147
148 /*! this is the first part of a sentence that is followed by a class name */
150 { return "This is the complete list of members for"; }
151
152 /*! this is the remainder of the sentence after the class name */
154 { return ", including all inherited members."; }
155
156 /*! this is put at the author sections at the bottom of man pages.
157 * parameter s is name of the project name.
158 */
160 { DString result="Generated automatically by Doxygen";
161 if (!s.empty()) result+=" for "+s;
162 result+=" from the source code.";
163 return result;
164 }
165
166 /*! put after an enum name in the list of all members */
168 { return "enum name"; }
169
170 /*! put after an enum value in the list of all members */
172 { return "enum value"; }
173
174 /*! put after an undocumented member in the list of all members */
176 { return "defined in"; }
177
178 // quick reference sections
179
180 /*! This is put above each page as a link to the list of all groups of
181 * compounds or files (see the \\group command).
182 */
184 { return "Modules"; }
185
186 /*! This is put above each page as a link to the class hierarchy */
188 { return "Class Hierarchy"; }
189
190 /*! This is put above each page as a link to the list of annotated classes */
192 {
193 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
194 {
195 return "Data Structures";
196 }
197 else
198 {
199 return "Class List";
200 }
201 }
202
203 /*! This is put above each page as a link to the list of documented files */
205 { return "File List"; }
206
207 /*! This is put above each page as a link to all members of compounds. */
209 {
210 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
211 {
212 return "Data Fields";
213 }
214 else
215 {
216 return "Class Members";
217 }
218 }
219
220 /*! This is put above each page as a link to all members of files. */
222 {
223 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
224 {
225 return "Globals";
226 }
227 else
228 {
229 return "File Members";
230 }
231 }
232
233 /*! This is put above each page as a link to all related pages. */
235 { return "Related Pages"; }
236
237 /*! This is put above each page as a link to all examples. */
239 { return "Examples"; }
240
241 /*! This is put above each page as a link to the search engine. */
242 DString trSearch() override
243 { return "Search"; }
244
245 /*! This is an introduction to the class hierarchy. */
247 {
248 if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
249 {
250 return "Here is a hierarchical list of all entities:";
251 }
252 else
253 {
254 return "This inheritance list is sorted roughly, "
255 "but not completely, alphabetically:";
256 }
257 }
258
259 /*! This is an introduction to the list with all files. */
260 DString trFileListDescription(bool extractAll) override
261 {
262 DString result="Here is a list of all ";
263 if (!extractAll) result+="documented ";
264 result+="files with brief descriptions:";
265 return result;
266 }
267
268 /*! This is an introduction to the annotated compound list. */
270 {
271
272 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
273 {
274 return "Here are the data structures with brief descriptions:";
275 }
276 else if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
277 {
278 return "Here are the classes with brief descriptions:";
279 }
280 else
281 {
282 return "Here are the classes, structs, "
283 "unions and interfaces with brief descriptions:";
284 }
285 }
286
287 /*! This is an introduction to the page with all class members. */
288 DString trCompoundMembersDescription(bool extractAll) override
289 {
290 DString result="Here is a list of all ";
291 if (!extractAll)
292 {
293 result+="documented ";
294 }
295 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
296 {
297 result+="struct and union fields";
298 }
299 else
300 {
301 result+="class members";
302 }
303 result+=" with links to ";
304 if (!extractAll)
305 {
306 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
307 {
308 result+="the struct/union documentation for each field:";
309 }
310 else
311 {
312 result+="the class documentation for each member:";
313 }
314 }
315 else
316 {
317 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
318 {
319 result+="the structures/unions they belong to:";
320 }
321 else
322 {
323 result+="the classes they belong to:";
324 }
325 }
326 return result;
327 }
328
329 /*! This is an introduction to the page with all file members. */
330 DString trFileMembersDescription(bool extractAll) override
331 {
332 DString result="Here is a list of all ";
333 if (!extractAll) result+="documented ";
334
335 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
336 {
337 result+="functions, variables, defines, enums, and typedefs";
338 }
339 else
340 {
341 result+="file members";
342 }
343 result+=" with links to ";
344 if (extractAll)
345 result+="the files they belong to:";
346 else
347 result+="the documentation:";
348 return result;
349 }
350
351 /*! This is an introduction to the page with the list of all examples */
353 { return "Here is a list of all examples:"; }
354
355 /*! This is an introduction to the page with the list of related pages */
357 { return "Here is a list of all related documentation pages:"; }
358
359 /*! This is an introduction to the page with the list of class/file groups */
361 { return "Here is a list of all modules:"; }
362
363 // index titles (the project name is prepended for these)
364
365 /*! This is used in HTML as the title of index.html. */
366 DString trDocumentation(const DString &projName) override
367 { return (!projName.empty()?projName + " " : "") + "Documentation"; }
368
369 /*! This is used in LaTeX as the title of the chapter with the
370 * index of all groups.
371 */
373 { return "Module Index"; }
374
375 /*! This is used in LaTeX as the title of the chapter with the
376 * class hierarchy.
377 */
379 { return "Hierarchical Index"; }
380
381 /*! This is used in LaTeX as the title of the chapter with the
382 * annotated compound index.
383 */
385 {
386 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
387 {
388 return "Data Structure Index";
389 }
390 else
391 {
392 return "Class Index";
393 }
394 }
395
396 /*! This is used in LaTeX as the title of the chapter with the
397 * list of all files.
398 */
400 { return "File Index"; }
401
402 /*! This is used in LaTeX as the title of the chapter containing
403 * the documentation of all groups.
404 */
406 { return "Module Documentation"; }
407
408 /*! This is used in LaTeX as the title of the chapter containing
409 * the documentation of all classes, structs and unions.
410 */
412 {
413 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
414 {
415 return "Data Structure Documentation";
416 }
417 else if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
418 {
420 }
421 else
422 {
423 return "Class Documentation";
424 }
425 }
426
427 /*! This is used in LaTeX as the title of the chapter containing
428 * the documentation of all files.
429 */
431 { return "File Documentation"; }
432
433 /*! This is used in LaTeX as the title of the document */
435 { return "Reference Manual"; }
436
437 /*! This is used in the documentation of a file as a header before the
438 * list of defines
439 */
441 { return "Macros"; }
442
443 /*! This is used in the documentation of a file as a header before the
444 * list of typedefs
445 */
447 { return "Typedefs"; }
448
449 /*! This is used in the documentation of a file as a header before the
450 * list of enumerations
451 */
453 { return "Enumerations"; }
454
455 /*! This is used in the documentation of a file as a header before the
456 * list of (global) functions
457 */
459 { return "Functions"; }
460
461 /*! This is used in the documentation of a file as a header before the
462 * list of (global) variables
463 */
465 { return "Variables"; }
466
467 /*! This is used in the documentation of a file as a header before the
468 * list of (global) variables
469 */
471 { return "Enumerator"; }
472
473 /*! This is used in the documentation of a file before the list of
474 * documentation blocks for defines
475 */
477 { return "Macro Definition Documentation"; }
478
479 /*! This is used in the documentation of a file/namespace before the list
480 * of documentation blocks for typedefs
481 */
483 { return "Typedef Documentation"; }
484
485 /*! This is used in the documentation of a file/namespace before the list
486 * of documentation blocks for enumeration types
487 */
489 { return "Enumeration Type Documentation"; }
490
491 /*! This is used in the documentation of a file/namespace before the list
492 * of documentation blocks for functions
493 */
495 { return "Function Documentation"; }
496
497 /*! This is used in the documentation of a file/namespace before the list
498 * of documentation blocks for variables
499 */
501 { return "Variable Documentation"; }
502
503 /*! This is used in the documentation of a file/namespace/group before
504 * the list of links to documented compounds
505 */
507 {
508 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
509 {
510 return "Data Structures";
511 }
512 else
513 {
514 return "Classes";
515 }
516 }
517
518 /*! This is used in the standard footer of each page and indicates when
519 * the page was generated
520 */
521 DString trGeneratedAt(const DString &date,const DString &projName) override
522 {
523 DString result="Generated on "+date;
524 if (!projName.empty()) result+=" for "+projName;
525 result+=" by";
526 return result;
527 }
528
529 /*! this text is put before a class diagram */
530 DString trClassDiagram(const DString &clName) override
531 {
532 return "Inheritance diagram for "+clName+":";
533 }
534
535 /*! this text is generated when the \\warning command is used. */
537 { return "Warning"; }
538
539 /*! this text is generated when the \\version command is used. */
541 { return "Version"; }
542
543 /*! this text is generated when the \\date command is used. */
544 DString trDate() override
545 { return "Date"; }
546
547 /*! this text is generated when the \\return command is used. */
549 { return "Returns"; }
550
551 /*! this text is generated when the \\sa command is used. */
553 { return "See also"; }
554
555 /*! this text is generated when the \\param command is used. */
557 { return "Parameters"; }
558
559 /*! this text is generated when the \\exception command is used. */
561 { return "Exceptions"; }
562
563 /*! this text is used in the title page of a LaTeX document. */
565 { return "Generated by"; }
566
567//////////////////////////////////////////////////////////////////////////
568// new since 0.49-990307
569//////////////////////////////////////////////////////////////////////////
570
571 /*! used as the title of page containing all the index of all namespaces. */
573 { return "Namespace List"; }
574
575 /*! used as an introduction to the namespace list */
576 DString trNamespaceListDescription(bool extractAll) override
577 {
578 DString result="Here is a list of all ";
579 if (!extractAll) result+="documented ";
580 result+="namespaces with brief descriptions:";
581 return result;
582 }
583
584 /*! used in the class documentation as a header before the list of all
585 * friends of a class
586 */
588 { return "Friends"; }
589
590//////////////////////////////////////////////////////////////////////////
591// new since 0.49-990405
592//////////////////////////////////////////////////////////////////////////
593
594 /*! used in the class documentation as a header before the list of all
595 * related classes
596 */
598 { return "Friends And Related Function Documentation"; }
599
600//////////////////////////////////////////////////////////////////////////
601// new since 0.49-990425
602//////////////////////////////////////////////////////////////////////////
603
604 /*! used as the title of the HTML page of a class/struct/union */
606 ClassDef::CompoundType compType,
607 bool isTemplate) override
608 {
609 DString result=clName;
610 switch(compType)
611 {
612 case ClassDef::Class: result+=" Class"; break;
613 case ClassDef::Struct: result+=" Struct"; break;
614 case ClassDef::Union: result+=" Union"; break;
615 case ClassDef::Interface: result+=" Interface"; break;
616 case ClassDef::Protocol: result+=" Protocol"; break;
617 case ClassDef::Category: result+=" Category"; break;
618 case ClassDef::Exception: result+=" Exception"; break;
619 default: break;
620 }
621 if (isTemplate) result+=" Template";
622 result+=" Reference";
623 return result;
624 }
625
626 /*! used as the title of the HTML page of a file */
627 DString trFileReference(const DString &fileName) override
628 {
629 DString result=fileName;
630 result+=" File Reference";
631 return result;
632 }
633
634 /*! used as the title of the HTML page of a namespace */
635 DString trNamespaceReference(const DString &namespaceName) override
636 {
637 DString result=namespaceName;
638 result+=" Namespace Reference";
639 return result;
640 }
641
643 { return "Public Member Functions"; }
645 { return "Public Slots"; }
647 { return "Signals"; }
649 { return "Static Public Member Functions"; }
651 { return "Protected Member Functions"; }
653 { return "Protected Slots"; }
655 { return "Static Protected Member Functions"; }
657 { return "Private Member Functions"; }
659 { return "Private Slots"; }
661 { return "Static Private Member Functions"; }
662
663 /*! this function is used to produce a comma-separated list of items.
664 * use generateMarker(i) to indicate where item i should be put.
665 */
666 DString trWriteList(int numEntries) override
667 {
668 DString result;
669 // the inherits list contain `numEntries' classes
670 for (int i=0;i<numEntries;i++)
671 {
672 // use generateMarker to generate placeholders for the class links!
673 result+=generateMarker(i); // generate marker for entry i in the list
674 // (order is left to right)
675
676 if (i!=numEntries-1) // not the last entry, so we need a separator
677 {
678 if (i<numEntries-2) // not the fore last entry
679 result+=", ";
680 else // the fore last entry
681 result+=", and ";
682 }
683 }
684 return result;
685 }
686
687 /*! used in class documentation to produce a list of base classes,
688 * if class diagrams are disabled.
689 */
690 DString trInheritsList(int numEntries) override
691 {
692 return "Inherits "+trWriteList(numEntries)+".";
693 }
694
695 /*! used in class documentation to produce a list of super classes,
696 * if class diagrams are disabled.
697 */
698 DString trInheritedByList(int numEntries) override
699 {
700 return "Inherited by "+trWriteList(numEntries)+".";
701 }
702
703 /*! used in member documentation blocks to produce a list of
704 * members that are hidden by this one.
705 */
706 DString trReimplementedFromList(int numEntries) override
707 {
708 return "Reimplemented from "+trWriteList(numEntries)+".";
709 }
710
711 /*! used in member documentation blocks to produce a list of
712 * all member that overwrite the implementation of this member.
713 */
714 DString trReimplementedInList(int numEntries) override
715 {
716 return "Reimplemented in "+trWriteList(numEntries)+".";
717 }
718
719 /*! This is put above each page as a link to all members of namespaces. */
721 { return "Namespace Members"; }
722
723 /*! This is an introduction to the page with all namespace members */
724 DString trNamespaceMemberDescription(bool extractAll) override
725 {
726 DString result="Here is a list of all ";
727 if (!extractAll) result+="documented ";
728 result+="namespace members with links to ";
729 if (extractAll)
730 result+="the namespace documentation for each member:";
731 else
732 result+="the namespaces they belong to:";
733 return result;
734 }
735 /*! This is used in LaTeX as the title of the chapter with the
736 * index of all namespaces.
737 */
739 { return "Namespace Index"; }
740
741 /*! This is used in LaTeX as the title of the chapter containing
742 * the documentation of all namespaces.
743 */
745 { return "Namespace Documentation"; }
746
747//////////////////////////////////////////////////////////////////////////
748// new since 0.49-990522
749//////////////////////////////////////////////////////////////////////////
750
751 /*! This is used in the documentation before the list of all
752 * namespaces in a file.
753 */
755 { return "Namespaces"; }
756
757//////////////////////////////////////////////////////////////////////////
758// new since 0.49-990728
759//////////////////////////////////////////////////////////////////////////
760
761 /*! This is put at the bottom of a class documentation page and is
762 * followed by a list of files that were used to generate the page.
763 */
765 bool single) override
766 { // single is true implies a single file
767 bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
768 DString result="The documentation for this ";
769 switch(compType)
770 {
771 case ClassDef::Class: result+=vhdlOpt?"design unit":"class"; break;
772 case ClassDef::Struct: result+="struct"; break;
773 case ClassDef::Union: result+="union"; break;
774 case ClassDef::Interface: result+="interface"; break;
775 case ClassDef::Protocol: result+="protocol"; break;
776 case ClassDef::Category: result+="category"; break;
777 case ClassDef::Exception: result+="exception"; break;
778 default: break;
779 }
780 result+=" was generated from the following file";
781 if (single) result+=":"; else result+="s:";
782 return result;
783 }
784
785//////////////////////////////////////////////////////////////////////////
786// new since 0.49-990901
787//////////////////////////////////////////////////////////////////////////
788
789 /*! This is used as the heading text for the retval command. */
791 { return "Return values"; }
792
793 /*! This is in the (quick) index as a link to the main page (index.html)
794 */
796 { return "Main Page"; }
797
798 /*! This is used in references to page that are put in the LaTeX
799 * documentation. It should be an abbreviation of the word page.
800 */
802 { return "p."; }
803
804//////////////////////////////////////////////////////////////////////////
805// new since 0.49-991003
806//////////////////////////////////////////////////////////////////////////
807
809 {
810 return "Definition at line @0 of file @1.";
811 }
813 {
814 return "Definition in file @0.";
815 }
816
817//////////////////////////////////////////////////////////////////////////
818// new since 0.49-991205
819//////////////////////////////////////////////////////////////////////////
820
822 {
823 return "Deprecated";
824 }
825
826//////////////////////////////////////////////////////////////////////////
827// new since 1.0.0
828//////////////////////////////////////////////////////////////////////////
829
830 /*! this text is put before a collaboration diagram */
831 DString trCollaborationDiagram(const DString &clName) override
832 {
833 return "Collaboration diagram for "+clName+":";
834 }
835 /*! this text is put before an include dependency graph */
836 DString trInclDepGraph(const DString &fName) override
837 {
838 return "Include dependency graph for "+fName+":";
839 }
840 /*! header that is put before the list of constructor/destructors. */
842 {
843 return "Constructor & Destructor Documentation";
844 }
845 /*! Used in the file documentation to point to the corresponding sources. */
847 {
848 return "Go to the source code of this file.";
849 }
850 /*! Used in the file sources to point to the corresponding documentation. */
852 {
853 return "Go to the documentation of this file.";
854 }
855 /*! Text for the \\pre command */
857 {
858 return "Precondition";
859 }
860 /*! Text for the \\post command */
862 {
863 return "Postcondition";
864 }
865 /*! Text for the \\invariant command */
867 {
868 return "Invariant";
869 }
870 /*! Text shown before a multi-line variable/enum initialization */
872 {
873 return "Initial value:";
874 }
875 /*! Text used the source code in the file index */
876 DString trCode() override
877 {
878 return "code";
879 }
881 {
882 return "Graphical Class Hierarchy";
883 }
885 {
886 return "Go to the graphical class hierarchy";
887 }
889 {
890 return "Go to the textual class hierarchy";
891 }
893 {
894 return "Page Index";
895 }
896
897//////////////////////////////////////////////////////////////////////////
898// new since 1.1.0
899//////////////////////////////////////////////////////////////////////////
900
901 DString trNote() override
902 {
903 return "Note";
904 }
906 {
907 return "Public Types";
908 }
910 {
911 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
912 {
913 return "Data Fields";
914 }
915 else
916 {
917 return "Public Attributes";
918 }
919 }
921 {
922 return "Static Public Attributes";
923 }
925 {
926 return "Protected Types";
927 }
929 {
930 return "Protected Attributes";
931 }
933 {
934 return "Static Protected Attributes";
935 }
937 {
938 return "Private Types";
939 }
941 {
942 return "Private Attributes";
943 }
945 {
946 return "Static Private Attributes";
947 }
948
949//////////////////////////////////////////////////////////////////////////
950// new since 1.1.3
951//////////////////////////////////////////////////////////////////////////
952
953 /*! Used as a marker that is put before a \\todo item */
954 DString trTodo() override
955 {
956 return "Todo";
957 }
958 /*! Used as the header of the todo list */
960 {
961 return "Todo List";
962 }
963
964//////////////////////////////////////////////////////////////////////////
965// new since 1.1.4
966//////////////////////////////////////////////////////////////////////////
967
969 {
970 return "Referenced by";
971 }
973 {
974 return "Remarks";
975 }
977 {
978 return "Attention";
979 }
981 {
982 return "This graph shows which files directly or "
983 "indirectly include this file:";
984 }
985 DString trSince() override
986 {
987 return "Since";
988 }
989
990//////////////////////////////////////////////////////////////////////////
991// new since 1.1.5
992//////////////////////////////////////////////////////////////////////////
993
994 /*! title of the graph legend page */
996 {
997 return "Graph Legend";
998 }
999 /*! page explaining how the dot graph's should be interpreted
1000 * The %A in the text below are to prevent link to classes called "A".
1001 */
1003 {
1004 return
1005 "This page explains how to interpret the graphs that are generated "
1006 "by doxygen.<p>\n"
1007 "Consider the following example:\n"
1008 "\\code\n"
1009 "/*! Invisible class because of truncation */\n"
1010 "class Invisible { };\n\n"
1011 "/*! Truncated class, inheritance relation is hidden */\n"
1012 "class Truncated : public Invisible { };\n\n"
1013 "/* Class not documented with doxygen comments */\n"
1014 "class Undocumented { };\n\n"
1015 "/*! Class that is inherited using public inheritance */\n"
1016 "class PublicBase : public Truncated { };\n\n"
1017 "/*! A template class */\n"
1018 "template<class T> class Templ { };\n\n"
1019 "/*! Class that is inherited using protected inheritance */\n"
1020 "class ProtectedBase { };\n\n"
1021 "/*! Class that is inherited using private inheritance */\n"
1022 "class PrivateBase { };\n\n"
1023 "/*! Class that is used by the Inherited class */\n"
1024 "class Used { };\n\n"
1025 "/*! Super class that inherits a number of other classes */\n"
1026 "class Inherited : public PublicBase,\n"
1027 " protected ProtectedBase,\n"
1028 " private PrivateBase,\n"
1029 " public Undocumented,\n"
1030 " public Templ<int>\n"
1031 "{\n"
1032 " private:\n"
1033 " Used *m_usedClass;\n"
1034 "};\n"
1035 "\\endcode\n"
1036 "This will result in the following graph:"
1037 "<p><center><img alt=\"\" src=\"graph_legend."+getDotImageExtension()+"\"></center></p>\n"
1038 "<p>\n"
1039 "The boxes in the above graph have the following meaning:\n"
1040 "</p>\n"
1041 "<ul>\n"
1042 "<li>%A filled gray box represents the struct or class for which the "
1043 "graph is generated.</li>\n"
1044 "<li>%A box with a black border denotes a documented struct or class.</li>\n"
1045 "<li>%A box with a gray border denotes an undocumented struct or class.</li>\n"
1046 "<li>%A box with a red border denotes a documented struct or class for"
1047 "which not all inheritance/containment relations are shown. %A graph is "
1048 "truncated if it does not fit within the specified boundaries.</li>\n"
1049 "</ul>\n"
1050 "<p>\n"
1051 "The arrows have the following meaning:\n"
1052 "</p>\n"
1053 "<ul>\n"
1054 "<li>%A blue arrow is used to visualize a public inheritance "
1055 "relation between two classes.</li>\n"
1056 "<li>%A dark green arrow is used for protected inheritance.</li>\n"
1057 "<li>%A dark red arrow is used for private inheritance.</li>\n"
1058 "<li>%A purple dashed arrow is used if a class is contained or used "
1059 "by another class. The arrow is labeled with the variable(s) "
1060 "through which the pointed class or struct is accessible.</li>\n"
1061 "<li>%A yellow dashed arrow denotes a relation between a template instance and "
1062 "the template class it was instantiated from. The arrow is labeled with "
1063 "the template parameters of the instance.</li>\n"
1064 "</ul>\n";
1065 }
1066 /*! text for the link to the legend page */
1068 {
1069 return "legend";
1070 }
1071
1072//////////////////////////////////////////////////////////////////////////
1073// new since 1.2.0
1074//////////////////////////////////////////////////////////////////////////
1075
1076 /*! Used as a marker that is put before a test item */
1077 DString trTest() override
1078 {
1079 return "Test";
1080 }
1081 /*! Used as the header of the test list */
1083 {
1084 return "Test List";
1085 }
1086
1087//////////////////////////////////////////////////////////////////////////
1088// new since 1.2.2
1089//////////////////////////////////////////////////////////////////////////
1090
1091 /*! Used as a section header for IDL properties */
1093 {
1094 return "Properties";
1095 }
1096 /*! Used as a section header for IDL property documentation */
1098 {
1099 return "Property Documentation";
1100 }
1101
1102//////////////////////////////////////////////////////////////////////////
1103// new since 1.2.4
1104//////////////////////////////////////////////////////////////////////////
1105
1106 /*! Used for Java classes in the summary section of Java packages */
1108 {
1109 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
1110 {
1111 return "Data Structures";
1112 }
1113 else
1114 {
1115 return "Classes";
1116 }
1117 }
1118 /*! Used as the title of a Java package */
1119 DString trPackage(const DString &name) override
1120 {
1121 return "Package "+name;
1122 }
1123 /*! The description of the package index page */
1125 {
1126 return "Here are the packages with brief descriptions (if available):";
1127 }
1128 /*! The link name in the Quick links header for each page */
1130 {
1131 return "Packages";
1132 }
1133 /*! Text shown before a multi-line define */
1135 {
1136 return "Value:";
1137 }
1138
1139//////////////////////////////////////////////////////////////////////////
1140// new since 1.2.5
1141//////////////////////////////////////////////////////////////////////////
1142
1143 /*! Used as a marker that is put before a \\bug item */
1144 DString trBug() override
1145 {
1146 return "Bug";
1147 }
1148 /*! Used as the header of the bug list */
1150 {
1151 return "Bug List";
1152 }
1153
1154//////////////////////////////////////////////////////////////////////////
1155// new since 1.2.6
1156//////////////////////////////////////////////////////////////////////////
1157
1158 /*! Used as ansicpg for RTF file
1159 *
1160 * The following table shows the correlation of Charset name, Charset Value and
1161 * <pre>
1162 * Codepage number:
1163 * Charset Name Charset Value(hex) Codepage number
1164 * ------------------------------------------------------
1165 * DEFAULT_CHARSET 1 (x01)
1166 * SYMBOL_CHARSET 2 (x02)
1167 * OEM_CHARSET 255 (xFF)
1168 * ANSI_CHARSET 0 (x00) 1252
1169 * RUSSIAN_CHARSET 204 (xCC) 1251
1170 * EE_CHARSET 238 (xEE) 1250
1171 * GREEK_CHARSET 161 (xA1) 1253
1172 * TURKISH_CHARSET 162 (xA2) 1254
1173 * BALTIC_CHARSET 186 (xBA) 1257
1174 * HEBREW_CHARSET 177 (xB1) 1255
1175 * ARABIC _CHARSET 178 (xB2) 1256
1176 * SHIFTJIS_CHARSET 128 (x80) 932
1177 * HANGEUL_CHARSET 129 (x81) 949
1178 * GB2313_CHARSET 134 (x86) 936
1179 * CHINESEBIG5_CHARSET 136 (x88) 950
1180 * </pre>
1181 *
1182 */
1184 {
1185 return "1252";
1186 }
1187
1188
1189 /*! Used as ansicpg for RTF fcharset
1190 * \see trRTFansicp() for a table of possible values.
1191 */
1193 {
1194 return "0";
1195 }
1196
1197 /*! Used as header RTF general index */
1199 {
1200 return "Index";
1201 }
1202
1203 /*! This is used for translation of the word that will possibly
1204 * be followed by a single name or by a list of names
1205 * of the category.
1206 */
1207 DString trClass(bool first_capital, bool singular) override
1208 {
1209 return createNoun(first_capital, singular, "class", "es");
1210 }
1211
1212 /*! This is used for translation of the word that will possibly
1213 * be followed by a single name or by a list of names
1214 * of the category.
1215 */
1216 DString trFile(bool first_capital, bool singular) override
1217 {
1218 return createNoun(first_capital, singular, "file", "s");
1219 }
1220
1221 /*! This is used for translation of the word that will possibly
1222 * be followed by a single name or by a list of names
1223 * of the category.
1224 */
1225 DString trNamespace(bool first_capital, bool singular) override
1226 {
1227 return createNoun(first_capital, singular, "namespace", "s");
1228 }
1229
1230 /*! This is used for translation of the word that will possibly
1231 * be followed by a single name or by a list of names
1232 * of the category.
1233 */
1234 DString trGroup(bool first_capital, bool singular) override
1235 {
1236 return createNoun(first_capital, singular, "module", "s");
1237 }
1238
1239 /*! This is used for translation of the word that will possibly
1240 * be followed by a single name or by a list of names
1241 * of the category.
1242 */
1243 DString trPage(bool first_capital, bool singular) override
1244 {
1245 return createNoun(first_capital, singular, "page", "s");
1246 }
1247
1248 /*! This is used for translation of the word that will possibly
1249 * be followed by a single name or by a list of names
1250 * of the category.
1251 */
1252 DString trMember(bool first_capital, bool singular) override
1253 {
1254 return createNoun(first_capital, singular, "member", "s");
1255 }
1256
1257 /*! This is used for translation of the word that will possibly
1258 * be followed by a single name or by a list of names
1259 * of the category.
1260 */
1261 DString trGlobal(bool first_capital, bool singular) override
1262 {
1263 return createNoun(first_capital, singular, "global", "s");
1264 }
1265
1266//////////////////////////////////////////////////////////////////////////
1267// new since 1.2.7
1268//////////////////////////////////////////////////////////////////////////
1269
1270 /*! This text is generated when the \\author command is used and
1271 * for the author section in man pages. */
1272 DString trAuthor(bool first_capital, bool singular) override
1273 {
1274 return createNoun(first_capital, singular, "author", "s");
1275 }
1276
1277//////////////////////////////////////////////////////////////////////////
1278// new since 1.2.11
1279//////////////////////////////////////////////////////////////////////////
1280
1281 /*! This text is put before the list of members referenced by a member
1282 */
1284 {
1285 return "References";
1286 }
1287
1288//////////////////////////////////////////////////////////////////////////
1289// new since 1.2.13
1290//////////////////////////////////////////////////////////////////////////
1291
1292 /*! used in member documentation blocks to produce a list of
1293 * members that are implemented by this one.
1294 */
1295 DString trImplementedFromList(int numEntries) override
1296 {
1297 return "Implements "+trWriteList(numEntries)+".";
1298 }
1299
1300 /*! used in member documentation blocks to produce a list of
1301 * all members that implement this abstract member.
1302 */
1303 DString trImplementedInList(int numEntries) override
1304 {
1305 return "Implemented in "+trWriteList(numEntries)+".";
1306 }
1307
1308//////////////////////////////////////////////////////////////////////////
1309// new since 1.2.16
1310//////////////////////////////////////////////////////////////////////////
1311
1312 /*! used in RTF documentation as a heading for the Table
1313 * of Contents.
1314 */
1316 {
1317 return "Table of Contents";
1318 }
1319
1320//////////////////////////////////////////////////////////////////////////
1321// new since 1.2.17
1322//////////////////////////////////////////////////////////////////////////
1323
1324 /*! Used as the header of the list of item that have been
1325 * flagged deprecated
1326 */
1328 {
1329 return "Deprecated List";
1330 }
1331
1332//////////////////////////////////////////////////////////////////////////
1333// new since 1.2.18
1334//////////////////////////////////////////////////////////////////////////
1335
1336 /*! Used as a header for declaration section of the events found in
1337 * a C# program
1338 */
1340 {
1341 return "Events";
1342 }
1343 /*! Header used for the documentation section of a class' events. */
1345 {
1346 return "Event Documentation";
1347 }
1348
1349//////////////////////////////////////////////////////////////////////////
1350// new since 1.3
1351//////////////////////////////////////////////////////////////////////////
1352
1353 /*! Used as a heading for a list of Java class types with package scope.
1354 */
1356 {
1357 return "Package Types";
1358 }
1359 /*! Used as a heading for a list of Java class functions with package
1360 * scope.
1361 */
1363 {
1364 return "Package Functions";
1365 }
1367 {
1368 return "Package Members";
1369 }
1370 /*! Used as a heading for a list of static Java class functions with
1371 * package scope.
1372 */
1374 {
1375 return "Static Package Functions";
1376 }
1377 /*! Used as a heading for a list of Java class variables with package
1378 * scope.
1379 */
1381 {
1382 return "Package Attributes";
1383 }
1384 /*! Used as a heading for a list of static Java class variables with
1385 * package scope.
1386 */
1388 {
1389 return "Static Package Attributes";
1390 }
1391
1392//////////////////////////////////////////////////////////////////////////
1393// new since 1.3.1
1394//////////////////////////////////////////////////////////////////////////
1395
1396 /*! Used in the quick index of a class/file/namespace member list page
1397 * to link to the unfiltered list of all members.
1398 */
1399 DString trAll() override
1400 {
1401 return "All";
1402 }
1403 /*! Put in front of the call graph for a function. */
1405 {
1406 return "Here is the call graph for this function:";
1407 }
1408
1409//////////////////////////////////////////////////////////////////////////
1410// new since 1.3.3
1411//////////////////////////////////////////////////////////////////////////
1412
1413 /*! This string is used as the title for the page listing the search
1414 * results.
1415 */
1417 {
1418 return "Search Results";
1419 }
1420 /*! This string is put just before listing the search results. The
1421 * text can be different depending on the number of documents found.
1422 * Inside the text you can put the special marker $num to insert
1423 * the number representing the actual number of search results.
1424 * The @a numDocuments parameter can be either 0, 1 or 2, where the
1425 * value 2 represents 2 or more matches. HTML markup is allowed inside
1426 * the returned string.
1427 */
1428 DString trSearchResults(int numDocuments) override
1429 {
1430 if (numDocuments==0)
1431 {
1432 return "Sorry, no documents matching your query.";
1433 }
1434 else if (numDocuments==1)
1435 {
1436 return "Found <b>1</b> document matching your query.";
1437 }
1438 else
1439 {
1440 return "Found <b>$num</b> documents matching your query. "
1441 "Showing best matches first.";
1442 }
1443 }
1444 /*! This string is put before the list of matched words, for each search
1445 * result. What follows is the list of words that matched the query.
1446 */
1448 {
1449 return "Matches:";
1450 }
1451
1452//////////////////////////////////////////////////////////////////////////
1453// new since 1.3.8
1454//////////////////////////////////////////////////////////////////////////
1455
1456 /*! This is used in HTML as the title of page with source code for file filename
1457 */
1458 DString trSourceFile(const DString& filename) override
1459 {
1460 return filename + " Source File";
1461 }
1462
1463//////////////////////////////////////////////////////////////////////////
1464// new since 1.3.9
1465//////////////////////////////////////////////////////////////////////////
1466
1467 /*! This is used as the name of the chapter containing the directory
1468 * hierarchy.
1469 */
1471 { return "Directory Hierarchy"; }
1472
1473 /*! This is used as the name of the chapter containing the documentation
1474 * of the directories.
1475 */
1477 { return "Directory Documentation"; }
1478
1479 /*! This is used as the title of the directory index and also in the
1480 * Quick links of an HTML page, to link to the directory hierarchy.
1481 */
1483 { return "Directories"; }
1484
1485 /*! This returns the title of a directory page. The name of the
1486 * directory is passed via \a dirName.
1487 */
1488 DString trDirReference(const DString &dirName) override
1489 { DString result=dirName; result+=" Directory Reference"; return result; }
1490
1491 /*! This returns the word directory with or without starting capital
1492 * (\a first_capital) and in singular or plural form (\a singular).
1493 */
1494 DString trDir(bool first_capital, bool singular) override
1495 {
1496 return createNoun(first_capital, singular, "director", "ies", "y");
1497 }
1498
1499//////////////////////////////////////////////////////////////////////////
1500// new since 1.4.1
1501//////////////////////////////////////////////////////////////////////////
1502
1503 /*! This text is added to the documentation when the \\overload command
1504 * is used for a overloaded function.
1505 */
1507 {
1508 return "This is an overloaded member function, "
1509 "provided for convenience. It differs from the above "
1510 "function only in what argument(s) it accepts.";
1511 }
1512
1513//////////////////////////////////////////////////////////////////////////
1514// new since 1.4.6
1515//////////////////////////////////////////////////////////////////////////
1516
1517 /*! This is used to introduce a caller (or called-by) graph */
1519 {
1520 return "Here is the caller graph for this function:";
1521 }
1522
1523 /*! This is used in the documentation of a file/namespace before the list
1524 * of documentation blocks for enumeration values
1525 */
1527 { return "Enumerator Documentation"; }
1528
1529//////////////////////////////////////////////////////////////////////////
1530// new since 1.5.4 (mainly for Fortran)
1531//////////////////////////////////////////////////////////////////////////
1532
1533 /*! header that is put before the list of member subprograms (Fortran). */
1535 { return "Member Function/Subroutine Documentation"; }
1536
1537 /*! This is put above each page as a link to the list of annotated data types (Fortran). */
1539 { return "Data Types List"; }
1540
1541 /*! This is put above each page as a link to all members of compounds (Fortran). */
1543 { return "Data Fields"; }
1544
1545 /*! This is an introduction to the annotated compound list (Fortran). */
1547 { return "Here are the data types with brief descriptions:"; }
1548
1549 /*! This is an introduction to the page with all data types (Fortran). */
1551 {
1552 DString result="Here is a list of all ";
1553 if (!extractAll)
1554 {
1555 result+="documented ";
1556 }
1557 result+="data types members";
1558 result+=" with links to ";
1559 if (!extractAll)
1560 {
1561 result+="the data structure documentation for each member";
1562 }
1563 else
1564 {
1565 result+="the data types they belong to:";
1566 }
1567 return result;
1568 }
1569
1570 /*! This is used in LaTeX as the title of the chapter with the
1571 * annotated compound index (Fortran).
1572 */
1574 { return "Data Type Index"; }
1575
1576 /*! This is used in LaTeX as the title of the chapter containing
1577 * the documentation of all data types (Fortran).
1578 */
1580 { return "Data Type Documentation"; }
1581
1582 /*! This is used in the documentation of a file as a header before the
1583 * list of (global) subprograms (Fortran).
1584 */
1586 { return "Functions/Subroutines"; }
1587
1588 /*! This is used in the documentation of a file/namespace before the list
1589 * of documentation blocks for subprograms (Fortran)
1590 */
1592 { return "Function/Subroutine Documentation"; }
1593
1594 /*! This is used in the documentation of a file/namespace/group before
1595 * the list of links to documented compounds (Fortran)
1596 */
1598 { return "Data Types"; }
1599
1600 /*! used as the title of page containing all the index of all modules (Fortran). */
1602 { return "Modules List"; }
1603
1604 /*! used as an introduction to the modules list (Fortran) */
1605 DString trModulesListDescription(bool extractAll) override
1606 {
1607 DString result="Here is a list of all ";
1608 if (!extractAll) result+="documented ";
1609 result+="modules with brief descriptions:";
1610 return result;
1611 }
1612
1613 /*! used as the title of the HTML page of a module/type (Fortran) */
1615 ClassDef::CompoundType compType,
1616 bool isTemplate) override
1617 {
1618 DString result=clName;
1619 switch(compType)
1620 {
1621 case ClassDef::Class: result+=" Module"; break;
1622 case ClassDef::Struct: result+=" Type"; break;
1623 case ClassDef::Union: result+=" Union"; break;
1624 case ClassDef::Interface: result+=" Interface"; break;
1625 case ClassDef::Protocol: result+=" Protocol"; break;
1626 case ClassDef::Category: result+=" Category"; break;
1627 case ClassDef::Exception: result+=" Exception"; break;
1628 default: break;
1629 }
1630 if (isTemplate) result+=" Template";
1631 result+=" Reference";
1632 return result;
1633 }
1634 /*! used as the title of the HTML page of a module (Fortran) */
1635 DString trModuleReference(const DString &namespaceName) override
1636 {
1637 DString result=namespaceName;
1638 result+=" Module Reference";
1639 return result;
1640 }
1641
1642 /*! This is put above each page as a link to all members of modules. (Fortran) */
1644 { return "Module Members"; }
1645
1646 /*! This is an introduction to the page with all modules members (Fortran) */
1647 DString trModulesMemberDescription(bool extractAll) override
1648 {
1649 DString result="Here is a list of all ";
1650 if (!extractAll) result+="documented ";
1651 result+="module members with links to ";
1652 if (extractAll)
1653 {
1654 result+="the module documentation for each member:";
1655 }
1656 else
1657 {
1658 result+="the modules they belong to:";
1659 }
1660 return result;
1661 }
1662
1663 /*! This is used in LaTeX as the title of the chapter with the
1664 * index of all modules (Fortran).
1665 */
1667 { return "Modules Index"; }
1668
1669 /*! This is used for translation of the word that will possibly
1670 * be followed by a single name or by a list of names
1671 * of the category.
1672 */
1673 DString trModule(bool first_capital, bool singular) override
1674 {
1675 return createNoun(first_capital, singular, "module", "s");
1676 }
1677
1678 /*! This is put at the bottom of a module documentation page and is
1679 * followed by a list of files that were used to generate the page.
1680 */
1682 bool single) override
1683 {
1684 // single is true implies a single file
1685 DString result="The documentation for this ";
1686 switch(compType)
1687 {
1688 case ClassDef::Class: result+="module"; break;
1689 case ClassDef::Struct: result+="type"; break;
1690 case ClassDef::Union: result+="union"; break;
1691 case ClassDef::Interface: result+="interface"; break;
1692 case ClassDef::Protocol: result+="protocol"; break;
1693 case ClassDef::Category: result+="category"; break;
1694 case ClassDef::Exception: result+="exception"; break;
1695 default: break;
1696 }
1697 result+=" was generated from the following file";
1698 if (single) result+=":"; else result+="s:";
1699 return result;
1700 }
1701
1702 /*! This is used for translation of the word that will possibly
1703 * be followed by a single name or by a list of names
1704 * of the category.
1705 */
1706 DString trType(bool first_capital, bool singular) override
1707 {
1708 return createNoun(first_capital, singular, "type", "s");
1709 }
1710
1711 /*! This is used for translation of the word that will possibly
1712 * be followed by a single name or by a list of names
1713 * of the category.
1714 */
1715 DString trSubprogram(bool first_capital, bool singular) override
1716 {
1717 return createNoun(first_capital, singular, "subprogram", "s");
1718 }
1719
1720 /*! C# Type Constraint list */
1722 {
1723 return "Type Constraints";
1724 }
1725
1726//////////////////////////////////////////////////////////////////////////
1727// new since 1.6.0 (mainly for the new search engine)
1728//////////////////////////////////////////////////////////////////////////
1729
1730 /*! directory relation for \a name */
1731 DString trDirRelation(const DString &name) override
1732 {
1733 return name+" Relation";
1734 }
1735
1736 /*! Loading message shown when loading search results */
1738 {
1739 return "Loading...";
1740 }
1741
1742 /*! Label used for search results in the global namespace */
1744 {
1745 return "Global Namespace";
1746 }
1747
1748 /*! Message shown while searching */
1750 {
1751 return "Searching...";
1752 }
1753
1754 /*! Text shown when no search results are found */
1756 {
1757 return "No Matches";
1758 }
1759
1760//////////////////////////////////////////////////////////////////////////
1761// new since 1.6.3 (missing items for the directory pages)
1762//////////////////////////////////////////////////////////////////////////
1763
1764 /*! when clicking a directory dependency label, a page with a
1765 * table is shown. The heading for the first column mentions the
1766 * source file that has a relation to another file.
1767 */
1768 DString trFileIn(const DString &name) override
1769 {
1770 return "File in "+name;
1771 }
1772
1773 /*! when clicking a directory dependency label, a page with a
1774 * table is shown. The heading for the second column mentions the
1775 * destination file that is included.
1776 */
1777 DString trIncludesFileIn(const DString &name) override
1778 {
1779 return "Includes file in "+name;
1780 }
1781
1782 /** Compiles a date string.
1783 * @param year Year in 4 digits
1784 * @param month Month of the year: 1=January
1785 * @param day Day of the Month: 1..31
1786 * @param dayOfWeek Day of the week: 1=Monday..7=Sunday
1787 * @param hour Hour of the day: 0..23
1788 * @param minutes Minutes in the hour: 0..59
1789 * @param seconds Seconds within the minute: 0..59
1790 * @param includeTime Include time in the result string?
1791 */
1792 DString trDateTime(int year,int month,int day,int dayOfWeek,
1793 int hour,int minutes,int seconds,
1794 DateTimeType includeTime) override
1795 {
1796 static const char *days[] = { "Mon","Tue","Wed","Thu","Fri","Sat","Sun" };
1797 static const char *months[] = { "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" };
1798 DString sdate;
1799 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Date)
1800 {
1801 sdate.sprintf("%s %s %d %d",days[dayOfWeek-1],months[month-1],day,year);
1802 }
1803 if (includeTime == DateTimeType::DateTime) sdate += " ";
1804 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Time)
1805 {
1806 DString stime;
1807 stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);
1808 sdate+=stime;
1809 }
1810 return sdate;
1811 }
1812 DString trDayOfWeek(int dayOfWeek, bool, bool full) override
1813 {
1814 static const char *days_short[] = { "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" };
1815 static const char *days_full[] = { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" };
1816 return full? days_full[dayOfWeek-1] : days_short[dayOfWeek-1];
1817 }
1818 DString trMonth(int month, bool, bool full) override
1819 {
1820 static const char *months_short[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1821 static const char *months_full[] = { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" };
1822 return full? months_full[month-1] : months_short[month-1];
1823 }
1824 DString trDayPeriod(bool period) override
1825 {
1826 static const char *dayPeriod[] = { "AM", "PM" };
1827 return dayPeriod[period?1:0];
1828 }
1829
1830//////////////////////////////////////////////////////////////////////////
1831// new since 1.7.5
1832//////////////////////////////////////////////////////////////////////////
1833
1834 /*! Header for the page with bibliographic citations */
1836 { return "Bibliography"; }
1837
1838 /*! Text for copyright paragraph */
1840 { return "Copyright"; }
1841
1842 /*! Header for the graph showing the directory dependencies */
1843 DString trDirDepGraph(const DString &name) override
1844 { return "Directory dependency graph for "+name+":"; }
1845
1846//////////////////////////////////////////////////////////////////////////
1847// new since 1.8.0
1848//////////////////////////////////////////////////////////////////////////
1849
1850 /*! Detail level selector shown for hierarchical indices */
1852 { return "detail level"; }
1853
1854 /*! Section header for list of template parameters */
1856 { return "Template Parameters"; }
1857
1858 /*! Used in dot graph when UML_LOOK is enabled and there are many fields */
1859 DString trAndMore(const DString &number) override
1860 { return "and "+number+" more..."; }
1861
1862 /*! Used file list for a Java enum */
1863 DString trEnumGeneratedFromFiles(bool single) override
1864 { DString result = "The documentation for this enum was generated from the following file";
1865 if (!single) result += "s";
1866 result+=":";
1867 return result;
1868 }
1869
1870 /*! Header of a Java enum page (Java enums are represented as classes). */
1871 DString trEnumReference(const DString &name) override
1872 { return name+" Enum Reference"; }
1873
1874 /*! Used for a section containing inherited members */
1875 DString trInheritedFrom(const DString &members,const DString &what) override
1876 { return members+" inherited from "+what; }
1877
1878 /*! Header of the sections with inherited members specific for the
1879 * base class(es)
1880 */
1882 { return "Additional Inherited Members"; }
1883
1884//////////////////////////////////////////////////////////////////////////
1885// new since 1.8.2
1886//////////////////////////////////////////////////////////////////////////
1887
1888 /*! Used as a tooltip for the toggle button that appears in the
1889 * navigation tree in the HTML output when GENERATE_TREEVIEW is
1890 * enabled. This tooltip explains the meaning of the button.
1891 */
1893 {
1894 DString opt = enable ? "enable" : "disable";
1895 return "click to "+opt+" panel synchronization";
1896 }
1897
1898 /*! Used in a method of an Objective-C class that is declared in a
1899 * a category. Note that the @1 marker is required and is replaced
1900 * by a link.
1901 */
1903 {
1904 return "Provided by category @0.";
1905 }
1906
1907 /*! Used in a method of an Objective-C category that extends a class.
1908 * Note that the @1 marker is required and is replaced by a link to
1909 * the class method.
1910 */
1912 {
1913 return "Extends class @0.";
1914 }
1915
1916 /*! Used as the header of a list of class methods in Objective-C.
1917 * These are similar to static public member functions in C++.
1918 */
1920 {
1921 return "Class Methods";
1922 }
1923
1924 /*! Used as the header of a list of instance methods in Objective-C.
1925 * These are similar to public member functions in C++.
1926 */
1928 {
1929 return "Instance Methods";
1930 }
1931
1932 /*! Used as the header of the member functions of an Objective-C class.
1933 */
1935 {
1936 return "Method Documentation";
1937 }
1938
1939//////////////////////////////////////////////////////////////////////////
1940// new since 1.8.4
1941//////////////////////////////////////////////////////////////////////////
1942
1943 /** old style UNO IDL services: implemented interfaces */
1945 { return "Exported Interfaces"; }
1946
1947 /** old style UNO IDL services: inherited services */
1949 { return "Included Services"; }
1950
1951 /** UNO IDL constant groups */
1953 { return "Constant Groups"; }
1954
1955 /** UNO IDL constant groups */
1956 DString trConstantGroupReference(const DString &namespaceName) override
1957 {
1958 DString result=namespaceName;
1959 result+=" Constant Group Reference";
1960 return result;
1961 }
1962 /** UNO IDL service page title */
1963 DString trServiceReference(const DString &sName) override
1964 {
1965 DString result=sName;
1966 result+=" Service Reference";
1967 return result;
1968 }
1969 /** UNO IDL singleton page title */
1970 DString trSingletonReference(const DString &sName) override
1971 {
1972 DString result=sName;
1973 result+=" Singleton Reference";
1974 return result;
1975 }
1976 /** UNO IDL service page */
1978 {
1979 // single is true implies a single file
1980 DString result="The documentation for this service "
1981 "was generated from the following file";
1982 if (single) result+=":"; else result+="s:";
1983 return result;
1984 }
1985 /** UNO IDL singleton page */
1987 {
1988 // single is true implies a single file
1989 DString result="The documentation for this singleton "
1990 "was generated from the following file";
1991 if (single) result+=":"; else result+="s:";
1992 return result;
1993 }
1994
1995//////////////////////////////////////////////////////////////////////////
1996// new since 1.8.15
1997//////////////////////////////////////////////////////////////////////////
1998
1999 /** VHDL design unit hierarchy */
2001 { return "Design Unit Hierarchy"; }
2002 /** VHDL design unit list */
2004 { return "Design Unit List"; }
2005 /** VHDL design unit members */
2007 { return "Design Unit Members"; }
2008 /** VHDL design unit list description */
2010 {
2011 return "Here is a list of all design unit members with links to "
2012 "the Entities they belong to:";
2013 }
2014 /** VHDL design unit index */
2016 { return "Design Unit Index"; }
2017 /** VHDL design units */
2019 { return "Design Units"; }
2020 /** VHDL functions/procedures/processes */
2022 { return "Functions/Procedures/Processes"; }
2023 /** VHDL type */
2024 DString trVhdlType(VhdlSpecifier type,bool single) override
2025 {
2026 switch(type)
2027 {
2029 if (single) return "Library";
2030 else return "Libraries";
2032 if (single) return "Package";
2033 else return "Packages";
2035 if (single) return "Signal";
2036 else return "Signals";
2038 if (single) return "Component";
2039 else return "Components";
2041 if (single) return "Constant";
2042 else return "Constants";
2044 if (single) return "Entity";
2045 else return "Entities";
2047 if (single) return "Type";
2048 else return "Types";
2050 if (single) return "Subtype";
2051 else return "Subtypes";
2053 if (single) return "Function";
2054 else return "Functions";
2056 if (single) return "Record";
2057 else return "Records";
2059 if (single) return "Procedure";
2060 else return "Procedures";
2062 if (single) return "Architecture";
2063 else return "Architectures";
2065 if (single) return "Attribute";
2066 else return "Attributes";
2068 if (single) return "Process";
2069 else return "Processes";
2071 if (single) return "Port";
2072 else return "Ports";
2073 case VhdlSpecifier::USE:
2074 if (single) return "use clause";
2075 else return "Use Clauses";
2077 if (single) return "Generic";
2078 else return "Generics";
2080 return "Package Body";
2082 return "Units";
2084 if (single) return "Shared Variable";
2085 else return "Shared Variables";
2087 if (single) return "File";
2088 else return "Files";
2090 if (single) return "Group";
2091 else return "Groups";
2093 if (single) return "Instantiation";
2094 else return "Instantiations";
2096 if (single) return "Alias";
2097 else return "Aliases";
2099 if (single) return "Configuration";
2100 else return "Configurations";
2102 return "Miscellaneous";
2104 return "Constraints";
2105 default:
2106 return "Class";
2107 }
2108 }
2109 DString trCustomReference(const DString &name) override
2110 { return name+" Reference"; }
2111
2112 /* Slice */
2114 {
2115 return "Constants";
2116 }
2118 {
2119 return "Constant Documentation";
2120 }
2122 {
2123 return "Sequences";
2124 }
2126 {
2127 return "Sequence Documentation";
2128 }
2130 {
2131 return "Dictionaries";
2132 }
2134 {
2135 return "Dictionary Documentation";
2136 }
2138 {
2139 return "Interfaces";
2140 }
2142 {
2143 return "Interface Index";
2144 }
2146 {
2147 return "Interface List";
2148 }
2150 {
2151 return "Here are the interfaces with brief descriptions:";
2152 }
2154 {
2155 return "Interface Hierarchy";
2156 }
2158 {
2159 return "This inheritance list is sorted roughly, but not completely, alphabetically:";
2160 }
2162 {
2163 return "Interface Documentation";
2164 }
2166 {
2167 return "Structs";
2168 }
2170 {
2171 return "Struct Index";
2172 }
2174 {
2175 return "Struct List";
2176 }
2178 {
2179 return "Here are the structs with brief descriptions:";
2180 }
2182 {
2183 return "Struct Documentation";
2184 }
2186 {
2187 return "Exception Index";
2188 }
2190 {
2191 return "Exception List";
2192 }
2194 {
2195 return "Here are the exceptions with brief descriptions:";
2196 }
2198 {
2199 return "Exception Hierarchy";
2200 }
2202 {
2203 return "This inheritance list is sorted roughly, but not completely, alphabetically:";
2204 }
2206 {
2207 return "Exception Documentation";
2208 }
2209 DString trCompoundReferenceSlice(const DString &clName, ClassDef::CompoundType compType, bool isLocal) override
2210 {
2211 DString result=clName;
2212 if (isLocal) result+=" Local";
2213 switch(compType)
2214 {
2215 case ClassDef::Class: result+=" Class"; break;
2216 case ClassDef::Struct: result+=" Struct"; break;
2217 case ClassDef::Union: result+=" Union"; break;
2218 case ClassDef::Interface: result+=" Interface"; break;
2219 case ClassDef::Protocol: result+=" Protocol"; break;
2220 case ClassDef::Category: result+=" Category"; break;
2221 case ClassDef::Exception: result+=" Exception"; break;
2222 default: break;
2223 }
2224 result+=" Reference";
2225 return result;
2226 }
2228 {
2229 return "Operations";
2230 }
2232 {
2233 return "Operation Documentation";
2234 }
2236 {
2237 return "Data Members";
2238 }
2240 {
2241 return "Data Member Documentation";
2242 }
2243
2244//////////////////////////////////////////////////////////////////////////
2245// new since 1.8.19
2246//////////////////////////////////////////////////////////////////////////
2247
2248 /** VHDL design unit documentation */
2250 { return "Design Unit Documentation"; }
2251
2252//////////////////////////////////////////////////////////////////////////
2253// new since 1.9.2
2254//////////////////////////////////////////////////////////////////////////
2255
2256 /** C++20 concept */
2257 DString trConcept(bool first_capital, bool singular) override
2258 {
2259 return createNoun(first_capital, singular, "concept", "s");
2260 }
2261 /*! used as the title of the HTML page of a C++20 concept page */
2262 DString trConceptReference(const DString &conceptName) override
2263 {
2264 DString result=conceptName;
2265 result+=" Concept Reference";
2266 return result;
2267 }
2268
2269 /*! used as the title of page containing all the index of all concepts. */
2271 { return "Concept List"; }
2272
2273 /*! used as the title of chapter containing the index listing all concepts. */
2275 { return "Concept Index"; }
2276
2277 /*! used as the title of chapter containing all information about concepts. */
2279 { return "Concept Documentation"; }
2280
2281 /*! used as an introduction to the concept list */
2282 DString trConceptListDescription(bool extractAll) override
2283 {
2284 DString result="Here is a list of all ";
2285 if (!extractAll) result+="documented ";
2286 result+="concepts with brief descriptions:";
2287 return result;
2288 }
2289
2290 /*! used to introduce the definition of the C++20 concept */
2292 {
2293 return "Concept definition";
2294 }
2295
2296//////////////////////////////////////////////////////////////////////////
2297// new since 1.9.4
2298//////////////////////////////////////////////////////////////////////////
2299
2301 { return "Package List"; }
2302
2303//////////////////////////////////////////////////////////////////////////
2304// new since 1.9.6
2305//////////////////////////////////////////////////////////////////////////
2306
2307 /*! This is used for translation of the word that will be
2308 * followed by a single name of the VHDL process flowchart.
2309 */
2311 { return "Flowchart:"; }
2312
2313 /*! Please translate also updated body of the method
2314 * trMemberFunctionDocumentation(), now better adapted for
2315 * VHDL sources documentation.
2316 */
2317
2318//////////////////////////////////////////////////////////////////////////
2319// new since 1.9.7
2320//////////////////////////////////////////////////////////////////////////
2321 /*! used in the compound documentation before a list of related symbols.
2322 *
2323 * Supersedes trRelatedFunctions
2324 */
2326 { return "Related Symbols"; }
2327
2328 /*! subscript for the related symbols
2329 *
2330 * Supersedes trRelatedSubscript
2331 */
2333 { return "(Note that these are not member symbols.)"; }
2334
2335 /*! used in the class documentation as a header before the list of all
2336 * related classes.
2337 *
2338 * Supersedes trRelatedFunctionDocumentation
2339 */
2341 { return "Friends And Related Symbol Documentation"; }
2342
2343 /*! the compound type as used for the xrefitems */
2345 {
2346 DString result;
2347 switch(compType)
2348 {
2349 case ClassDef::Class:
2350 if (lang == SrcLangExt::Fortran) result=trType(true,true);
2351 else result=trClass(true,true);
2352 break;
2353 case ClassDef::Struct: result="Struct"; break;
2354 case ClassDef::Union: result="Union"; break;
2355 case ClassDef::Interface: result="Interface"; break;
2356 case ClassDef::Protocol: result="Protocol"; break;
2357 case ClassDef::Category: result="Category"; break;
2358 case ClassDef::Exception: result="Exception"; break;
2359 case ClassDef::Service: result="Service"; break;
2360 case ClassDef::Singleton: result="Singleton"; break;
2361 default: break;
2362 }
2363 return result;
2364 }
2365
2367 {
2368 bool extractAll = Config_getBool(EXTRACT_ALL);
2369 DString result="Here is a list of all ";
2370 if (!extractAll) result+="documented ";
2371
2372 switch (hl)
2373 {
2375 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
2376 {
2377 result+="functions, variables, defines, enums, and typedefs";
2378 }
2379 else
2380 {
2381 result+="file members";
2382 }
2383 break;
2385 result+="functions";
2386 break;
2388 result+="variables";
2389 break;
2391 result+="typedefs";
2392 break;
2394 result+="sequences";
2395 break;
2397 result+="dictionaries";
2398 break;
2400 result+="enums";
2401 break;
2403 result+="enum values";
2404 break;
2406 result+="macros";
2407 break;
2408 case FileMemberHighlight::Total: // for completeness
2409 break;
2410 }
2411 result+=" with links to ";
2412 if (extractAll)
2413 result+="the files they belong to:";
2414 else
2415 result+="the documentation:";
2416 return result;
2417 }
2419 {
2420 bool extractAll = Config_getBool(EXTRACT_ALL);
2421 DString result="Here is a list of all ";
2422 if (!extractAll)
2423 {
2424 result+="documented ";
2425 }
2426
2427 switch (hl)
2428 {
2430 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
2431 {
2432 result+="struct and union fields";
2433 }
2434 else
2435 {
2436 result+="class members";
2437 }
2438 break;
2440 result+="functions";
2441 break;
2443 result+="variables";
2444 break;
2446 result+="typedefs";
2447 break;
2449 result+="enums";
2450 break;
2452 result+="enum values";
2453 break;
2455 result+="properties";
2456 break;
2458 result+="events";
2459 break;
2461 result+="related symbols";
2462 break;
2463 case ClassMemberHighlight::Total: // for completeness
2464 break;
2465 }
2466 result+=" with links to ";
2467 if (!extractAll)
2468 {
2469 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
2470 {
2471 result+="the struct/union documentation for each field:";
2472 }
2473 else
2474 {
2475 result+="the class documentation for each member:";
2476 }
2477 }
2478 else
2479 {
2480 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
2481 {
2482 result+="the structures/unions they belong to:";
2483 }
2484 else
2485 {
2486 result+="the classes they belong to:";
2487 }
2488 }
2489 return result;
2490 }
2492 {
2493 bool extractAll = Config_getBool(EXTRACT_ALL);
2494 DString result="Here is a list of all ";
2495 if (!extractAll) result+="documented ";
2496 result+="namespace ";
2497 DString singularResult = "";
2498 DString pluralResult = "";
2499 switch (hl)
2500 {
2502 singularResult="member";
2503 break;
2505 singularResult="function";
2506 break;
2508 singularResult="variable";
2509 break;
2511 singularResult="typedef";
2512 break;
2514 singularResult="sequence";
2515 break;
2517 singularResult="dictionary";
2518 pluralResult="dictionaries";
2519 break;
2521 singularResult="enum";
2522 break;
2524 singularResult="enum value";
2525 break;
2526 case NamespaceMemberHighlight::Total: // for completeness
2527 break;
2528 }
2529 result+=(pluralResult.empty() ? singularResult+"s" : pluralResult);
2530 result+=" with links to ";
2531 if (extractAll)
2532 result+="the namespace documentation for each " + singularResult + ":";
2533 else
2534 result+="the namespaces they belong to:";
2535 return result;
2536 }
2537 DString trDefinition() override { return "Definition";}
2538 DString trDeclaration() override { return "Declaration";}
2539
2540//////////////////////////////////////////////////////////////////////////
2541// new since 1.9.8
2542//////////////////////////////////////////////////////////////////////////
2543
2545 { return "Topics"; }
2547 { return "Topic Documentation"; }
2549 { return "Topic List"; }
2551 { return "Topic Index"; }
2553 { return "Here is a list of all topics with brief descriptions:"; }
2555 {
2556 bool extractAll = Config_getBool(EXTRACT_ALL);
2557 DString result="Here is a list of all ";
2558 if (!extractAll) result+="documented ";
2559 result+="module ";
2560 DString singularResult = "";
2561 DString pluralResult = "";
2562 switch (hl)
2563 {
2565 singularResult="member";
2566 break;
2568 singularResult="function";
2569 break;
2571 singularResult="variable";
2572 break;
2574 singularResult="typedef";
2575 break;
2577 singularResult="enum";
2578 break;
2580 singularResult="enum value";
2581 break;
2582 case ModuleMemberHighlight::Total: // for completeness
2583 break;
2584 }
2585 result+=(pluralResult.empty() ? singularResult+"s" : pluralResult);
2586 result+=" with links to ";
2587 if (extractAll)
2588 result+="the module documentation for each " + singularResult + ":";
2589 else
2590 result+="the module they belong to:";
2591 return result;
2592 }
2594 {
2595 return "Exported Modules";
2596 }
2597
2598//////////////////////////////////////////////////////////////////////////
2599// new since 1.10.0
2600//////////////////////////////////////////////////////////////////////////
2601
2603 {
2604 return "Copy to clipboard";
2605 }
2606//////////////////////////////////////////////////////////////////////////
2607// new since 1.11.0
2608//////////////////////////////////////////////////////////////////////////
2610 {
2611 return "Important";
2612 }
2613
2614//////////////////////////////////////////////////////////////////////////
2615// new since 1.16.0
2616//////////////////////////////////////////////////////////////////////////
2617
2618 // the title of the requirements overview page
2620 {
2621 return "Requirements";
2622 }
2623 // table header for the column with the requirements IDs
2625 {
2626 return "ID";
2627 }
2628 // indicates a symbol implements (satisfies) a requirement
2629 DString trSatisfies(bool singular) override
2630 {
2631 return createNoun(true, singular, "Satisfies requirement", "s");
2632 }
2633 // indicates a requirement is satisfied (implemented) by one or more symbols
2634 DString trSatisfiedBy(const DString &list) override
2635 {
2636 return "Satisfied by "+list+".";
2637 }
2639 {
2640 return "Unsatisfied Requirements";
2641 }
2642 DString trUnsatisfiedRequirementsText(bool singular,const DString &list) override
2643 {
2644 return singular ?
2645 "The requirement "+list+" does not have a 'satisfies' relation." :
2646 "The requirements "+list+" do not have a 'satisfies' relation.";
2647 }
2648 // indicates a symbol verifies (tests) a requirement
2649 DString trVerifies(bool singular) override
2650 {
2651 return createNoun(true, singular, "Verifies requirement", "s");
2652 }
2653 // indicates a requirement is verified (tested) by one or more symbols
2654 DString trVerifiedBy(const DString &list) override
2655 {
2656 return "Verified by "+list+".";
2657 }
2659 {
2660 return "Unverified Requirements";
2661 }
2662 DString trUnverifiedRequirementsText(bool singular,const DString &list) override
2663 {
2664 return singular ?
2665 "The requirement "+list+" does not have a 'verifies' relation." :
2666 "The requirements "+list+" do not have a 'verifies' relation.";
2667 }
2668
2669};
2670
2671#endif
CompoundType
The various compound types.
Definition classdef.h:105
@ Singleton
Definition classdef.h:113
@ Interface
Definition classdef.h:108
@ Exception
Definition classdef.h:111
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:88
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:152
DString & sprintf(const char *format,...)
Definition dstring.cpp:30
DString trSearchMatches() override
DString getLanguageString() override
language codes for Html help
DString trTemplateParameters() override
DString trSingletonReference(const DString &sName) override
UNO IDL singleton page title.
DString trTopicDocumentation() override
DString trCiteReferences() override
DString trDictionaries() override
DString trInheritsList(int numEntries) override
DString trPackageAttribs() override
DString trInterfaceHierarchy() override
DString trSequences() override
DString trMemberFunctionDocumentationFortran() override
DString trConceptList() override
DString trNamespaceReference(const DString &namespaceName) override
DString trReferenceManual() override
DString trDate() override
DString trMember(bool first_capital, bool singular) override
DString trFriends() override
DString trGotoSourceCode() override
DString trMemberDataDocumentation() override
DString trWarning() override
DString trDayPeriod(bool period) override
DString trStaticPackageAttribs() override
DString trPackageMembers() override
DString trProtectedAttribs() override
DString trFunctions() override
DString trFileDocumentation() override
DString trHierarchicalIndex() override
DString trExceptionListDescription() override
DString trInterfaceList() override
DString trTypeDocumentation() override
DString trFileList() override
DString trDesignUnitHierarchy() override
VHDL design unit hierarchy.
DString trSequenceDocumentation() override
DString trDetailedDescription() override
DString trInterfaces() override
old style UNO IDL services: implemented interfaces
DString trExceptionList() override
DString trStructDocumentation() override
DString trLegend() override
DString trEnumGeneratedFromFiles(bool single) override
DString trSearching() override
DString trModulesDescription() override
DString trEnumerationTypeDocumentation() override
DString trFileListDescription(bool extractAll) override
DString trCompoundList() override
DString trDetailLevel() override
DString trExceptions() override
DString trSearchResultsTitle() override
DString trClass(bool first_capital, bool singular) override
DString trStaticPrivateMembers() override
DString trProtectedMembers() override
DString trEventDocumentation() override
DString trExtendsClass() override
DString trConstantGroups() override
UNO IDL constant groups.
DString trDirectories() override
DString trEnumerations() override
DString trExportedModules() override
DString trRelatedSubscript() override
DString trUnverifiedRequirementsText(bool singular, const DString &list) override
DString trCompoundListDescriptionFortran() override
DString trCompoundMembersDescriptionTotal(ClassMemberHighlight::Enum hl) override
DString trImplementedInList(int numEntries) override
DString trDesignUnitListDescription() override
VHDL design unit list description.
DString trNamespace(bool first_capital, bool singular) override
DString trCompoundReferenceFortran(const DString &clName, ClassDef::CompoundType compType, bool isTemplate) override
DString trReimplementedFromList(int numEntries) override
DString trDefinedInSourceFile() override
DString trImportant() override
DString trEnumName() override
DString trCompoundReference(const DString &clName, ClassDef::CompoundType compType, bool isTemplate) override
DString trCallerGraph() override
DString trReimplementedInList(int numEntries) override
DString trSatisfiedBy(const DString &list) override
DString trFileMembers() override
DString trGeneratedFromFiles(ClassDef::CompoundType compType, bool single) override
DString trEvents() override
DString trAttention() override
DString trModulesMemberDescription(bool extractAll) override
DString trClassHierarchy() override
DString trMonth(int month, bool, bool full) override
DString trGlobal(bool first_capital, bool singular) override
DString trPrivateSlots() override
DString trClassMethods() override
DString trReferencedBy() override
DString trSubprograms() override
DString trMemberEnumerationDocumentation() override
DString trOperationDocumentation() override
DString trClassHierarchyDescription() override
DString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single) override
DString trGeneratedAutomatically(const DString &s) override
DString trSignals() override
DString trRelatedSymbolsSubscript() override
DString trProperties() override
DString trLegendDocs() override
DString trModuleReference(const DString &namespaceName) override
DString trGotoDocumentation() override
DString trModuleMembersDescriptionTotal(ModuleMemberHighlight::Enum hl) override
DString trCustomReference(const DString &name) override
DString trDesignUnitIndex() override
VHDL design unit index.
DString trTopicList() override
DString trInitialValue() override
DString trPrivateTypes() override
DString trDirRelation(const DString &name) override
DString trAndMore(const DString &number) override
DString trDefinedAtLineInSourceFile() override
DString trNamespaceListDescription(bool extractAll) override
DString trLegendTitle() override
DString trConstants() override
DString trStructListDescription() override
DString trConstantGroupReference(const DString &namespaceName) override
UNO IDL constant groups.
DString trPanelSynchronisationTooltip(bool enable) override
DString trServiceGeneratedFromFiles(bool single) override
UNO IDL service page.
DString trCompoundIndexFortran() override
DString trGraphicalHierarchy() override
DString trRTFGeneralIndex() override
DString trDirIndex() override
DString trFileIndex() override
DString trConstantDocumentation() override
DString trProtectedTypes() override
DString trPageIndex() override
DString trClassDocumentation() override
DString trOverloadText() override
DString trCode() override
DString trVariables() override
DString trPrivateMembers() override
DString trIncludingInheritedMembers() override
DString trProtectedSlots() override
DString trUnverifiedRequirements() override
DString trTestList() override
DString trReturnValues() override
DString trCompoundListDescription() override
DString trInterfaceHierarchyDescription() override
DString trExceptionIndex() override
DString trSliceInterfaces() override
DString trTodoList() override
DString trModulesIndex() override
DString trCopyToClipboard() override
DString trPackageListDescription() override
DString trConceptIndex() override
DString trFileReference(const DString &fileName) override
DString trNamespaceDocumentation() override
DString trInterfaceDocumentation() override
DString trAll() override
DString trNamespaces() override
DString trSeeAlso() override
DString trDictionaryDocumentation() override
DString trExceptionDocumentation() override
DString trGotoGraphicalHierarchy() override
DString trRelatedFunctionDocumentation() override
DString trCollaborationDiagram(const DString &clName) override
DString trRelatedSymbolDocumentation() override
DString trModulesMembers() override
DString trCompoundType(ClassDef::CompoundType compType, SrcLangExt lang) override
DString trClasses() override
DString trDirReference(const DString &dirName) override
DString trDeprecated() override
DString trEnumReference(const DString &name) override
DString trInclDepGraph(const DString &fName) override
DString trRelatedPages() override
DString trDirDepGraph(const DString &name) override
DString trThisIsTheListOfAllMembers() override
DString trPage(bool first_capital, bool singular) override
DString trEnumValue() override
DString trCompoundMembersDescription(bool extractAll) override
DString trDocumentation(const DString &projName) override
DString trServices() override
old style UNO IDL services: inherited services
DString trRelatedSymbols() override
DString trPublicSlots() override
DString trStaticProtectedMembers() override
DString trPackageFunctions() override
DString trRTFansicp() override
DString trStaticPublicAttribs() override
DString trPackageTypes() override
DString trCallGraph() override
DString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime) override
Compiles a date string.
DString trAdditionalInheritedMembers() override
DString trRequirements() override
DString trStructs() override
DString trModules() override
DString trDeprecatedList() override
DString trSatisfies(bool singular) override
DString idLanguage() override
DString trCompoundReferenceSlice(const DString &clName, ClassDef::CompoundType compType, bool isLocal) override
DString trSourceFile(const DString &filename) override
DString trModulesListDescription(bool extractAll) override
DString trGroup(bool first_capital, bool singular) override
DString trNamespaceMembers() override
DString trMemberFunctionDocumentation() override
DString trFileIn(const DString &name) override
DString trFunctionDocumentation() override
DString trPublicAttribs() override
DString trSubprogram(bool first_capital, bool singular) override
DString trDayOfWeek(int dayOfWeek, bool, bool full) override
DString trGotoTextualHierarchy() override
DString trStaticProtectedAttribs() override
DString trTypedefDocumentation() override
DString trPackages() override
DString trPublicMembers() override
DString trNoMatches() override
DString trRemarks() override
DString trStructList() override
DString trSearch() override
DString trStaticPrivateAttribs() override
DString trExceptionHierarchyDescription() override
DString trInterfaceIndex() override
DString trVersion() override
DString trReferences() override
DString trMemberTypedefDocumentation() override
DString trCompoundMembersFortran() override
DString trMethodDocumentation() override
DString trRequirementID() override
DString trDesignUnitList() override
VHDL design unit list.
DString trConceptDefinition() override
DString trProvidedByCategory() override
DString trExceptionHierarchy() override
DString trVariableDocumentation() override
DString trDefinedIn() override
DString trDetails() override
DString trFileMembersDescriptionTotal(FileMemberHighlight::Enum hl) override
DString trDefineDocumentation() override
DString trDataMemberDocumentation() override
DString trDataMembers() override
DString trNote() override
DString trConstructorDocumentation() override
DString trClassDiagram(const DString &clName) override
DString trInvariant() override
DString trDesignUnitDocumentation() override
VHDL design unit documentation.
DString trBug() override
DString trTypedefs() override
DString trUnsatisfiedRequirements() override
DString trModule(bool first_capital, bool singular) override
DString trConceptDocumentation() override
DString trVhdlType(VhdlSpecifier type, bool single) override
VHDL type.
DString trBugList() override
DString trTopicListDescription() override
DString trDataTypes() override
DString trUnsatisfiedRequirementsText(bool singular, const DString &list) override
DString trStructIndex() override
DString trStaticPublicMembers() override
DString trFileMembersDescription(bool extractAll) override
DString trGlobalNamespace() override
DString trInheritedFrom(const DString &members, const DString &what) override
DString trDeclaration() override
DString trConceptReference(const DString &conceptName) override
DString trFunctionAndProc() override
VHDL functions/procedures/processes.
DString trConceptListDescription(bool extractAll) override
DString trRTFCharSet() override
DString trSubprogramDocumentation() override
DString trNamespaceMembersDescriptionTotal(NamespaceMemberHighlight::Enum hl) override
DString trModulesList() override
DString trNamespaceIndex() override
DString trImplementedFromList(int numEntries) override
DString trDesignUnitMembers() override
VHDL design unit members.
DString trTopicIndex() override
DString trWriteList(int numEntries) override
DString trExamples() override
DString trIncludesFileIn(const DString &name) override
DString trISOLang() override
DString trMemberList() override
DString trInheritedByList(int numEntries) override
DString trTest() override
DString trListOfAllMembers() override
DString trDefinition() override
DString trNamespaceMemberDescription(bool extractAll) override
DString trNamespaceList() override
DString trCompoundListFortran() override
DString trGeneratedAt(const DString &date, const DString &projName) override
DString trExamplesDescription() override
DString trPackageList() override
DString trServiceReference(const DString &sName) override
UNO IDL service page title.
DString trOperations() override
DString trPublicTypes() override
DString trInterfaceListDescription() override
DString trGeneratedBy() override
DString trInstanceMethods() override
DString trFile(bool first_capital, bool singular) override
DString trEnumerationValues() override
DString trPackage(const DString &name) override
DString trSince() override
DString trLoading() override
DString latexLanguageSupportCommand() override
DString trCopyright() override
DString trAuthor(bool first_capital, bool singular) override
DString trStaticPackageFunctions() override
DString trDesignUnits() override
VHDL design units.
DString trModuleDocumentation() override
DString trRTFTableOfContents() override
DString trCompoundMembers() override
DString trFlowchart() override
DString trPostcondition() override
DString trTopics() override
DString trPageAbbreviation() override
DString trCompounds() override
DString trDefines() override
DString trTypeConstraints() override
DString trType(bool first_capital, bool singular) override
DString trPropertyDocumentation() override
DString trReturns() override
DString trSingletonGeneratedFromFiles(bool single) override
UNO IDL singleton page.
DString trRelatedPagesDescription() override
DString trEnumerationValueDocumentation() override
DString trDir(bool first_capital, bool singular) override
DString trSearchResults(int numDocuments) override
DString trDefineValue() override
DString trCompoundMembersDescriptionFortran(bool extractAll) override
DString trDirDocumentation() override
DString trCompoundIndex() override
DString trMore() override
DString trRelatedFunctions() override
DString trMainPage() override
DString trParameters() override
DString trVerifies(bool singular) override
DString trInclByDepGraph() override
DString trVerifiedBy(const DString &list) override
DString trConcept(bool first_capital, bool singular) override
C++20 concept.
DString trModuleIndex() override
DString trTodo() override
DString trPrivateAttribs() override
DString trPrecondition() override
Abstract base class for all translatable text fragments.
Definition translator.h:27
DString createNoun(bool first_capital, bool singular, const DString &base, const DString &plurSuffix, const DString &singSuffix="")
Definition translator.h:799
#define Config_getBool(name)
Definition config.h:33
DateTimeType
Definition datetime.h:38
DString generateMarker(int id)
Definition dstring.h:908
SrcLangExt
Definition types.h:207
VhdlSpecifier
Definition types.h:770
@ INSTANTIATION
Definition types.h:791
@ MISCELLANEOUS
Definition types.h:797
@ SHAREDVARIABLE
Definition types.h:794
DString getDotImageExtension()
Definition util.cpp:4966