696 "doxygen's defaults, run doxygen with the -l option. You can optionally specify a\n" |
696 "doxygen's defaults, run doxygen with the -l option. You can optionally specify a\n" |
697 "file name after the option, if omitted DoxygenLayout.xml will be used as the name\n" |
697 "file name after the option, if omitted DoxygenLayout.xml will be used as the name\n" |
698 "of the layout file." |
698 "of the layout file." |
699 ); |
699 ); |
700 cs->setWidgetType(ConfigString::File); |
700 cs->setWidgetType(ConfigString::File); |
|
701 //---- |
|
702 cb = cfg->addBool( |
|
703 "OUTPUT_INCLUDES", |
|
704 "If set this will write out documentation for #included files so that links can be\n" |
|
705 "made from INPUT files to them.\n" |
|
706 "if PREPROCESS_INCLUDES is not set then this has no effect. You are strongly advised to have EXTRACT_ALL = YES, if not some include files\n" |
|
707 "may not be linkable to.", |
|
708 FALSE |
|
709 ); |
701 //--------------------------------------------------------------------------- |
710 //--------------------------------------------------------------------------- |
702 cfg->addInfo("Messages","configuration options related to warning and progress messages"); |
711 cfg->addInfo("Messages","configuration options related to warning and progress messages"); |
703 //--------------------------------------------------------------------------- |
712 //--------------------------------------------------------------------------- |
704 |
713 |
705 //---- |
714 //---- |
1686 FALSE |
1695 FALSE |
1687 ); |
1696 ); |
1688 //---- |
1697 //---- |
1689 cs = cfg->addString( |
1698 cs = cfg->addString( |
1690 "XML_DITA_OUTPUT", |
1699 "XML_DITA_OUTPUT", |
1691 "The XML_DITA_ OUTPUT tag is used to specify where the DITA XML pages will be put.\n" |
1700 "The XML_DITA_OUTPUT tag is used to specify where the DITA XML pages will be put.\n" |
1692 "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" |
1701 "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" |
1693 "put in front of it. If left blank `dita' will be used as the default path." |
1702 "put in front of it. If left blank `dita' will be used as the default path." |
1694 ); |
1703 ); |
1695 cs->setDefaultValue("dita"); |
1704 cs->setDefaultValue("dita"); |
1696 cs->setWidgetType(ConfigString::Dir); |
1705 cs->setWidgetType(ConfigString::Dir); |
1697 cs->addDependency("GENERATE_XML_DITA"); |
1706 cs->addDependency("GENERATE_XML_DITA"); |
|
1707 //---- |
|
1708 cs = cfg->addString( |
|
1709 "XML_DITA_EXTENSION", |
|
1710 "The XML_DITA_EXTENSION is used to specify the file extension for DITA XML pages." |
|
1711 ); |
|
1712 cs->setDefaultValue(".xml"); |
|
1713 cs->addDependency("GENERATE_XML_DITA"); |
|
1714 //---- |
|
1715 cs = cfg->addString( |
|
1716 "XML_DITA_EXTENSION_DITAMAP", |
|
1717 "The XML_DITA_EXTENSION_DITAMAP is used to specify the file extension for DITA maps." |
|
1718 ); |
|
1719 cs->setDefaultValue(".ditamap"); |
|
1720 cs->addDependency("GENERATE_XML_DITA"); |
|
1721 //---- |
|
1722 cb = cfg->addBool( |
|
1723 "XML_DITA_OMIT_UNLINKABLE", |
|
1724 "If the XML_DITA_OMIT_UNLINKABLE tag is set to YES Doxygen will\n" |
|
1725 "not generate DITA XML files for classes that are not fully defined\n" |
|
1726 "(i.e. classes that have member functions that are declared but not defined).\n" |
|
1727 "This happens in component based builds where where Doxygen can see class\n" |
|
1728 "declarations in a header file but not the implememtation of those declarations.\n" |
|
1729 "In that case the documentation for those classes will not be generated.", |
|
1730 FALSE |
|
1731 ); |
|
1732 cb->addDependency("GENERATE_XML_DITA"); |
|
1733 //---- |
|
1734 cb = cfg->addBool( |
|
1735 "XML_DITA_OMIT_DUPLICATE_MEMBERS", |
|
1736 "If the XML_DITA_OMIT_DUPLICATE_MEMBERS tag is set to YES Doxygen will\n" |
|
1737 "not generate DITA XML members that have duplicate IDs.", |
|
1738 FALSE |
|
1739 ); |
|
1740 cb->addDependency("GENERATE_XML_DITA"); |
1698 //--------------------------------------------------------------------------- |
1741 //--------------------------------------------------------------------------- |
1699 cfg->addInfo("DEF","configuration options for the AutoGen Definitions output"); |
1742 cfg->addInfo("DEF","configuration options for the AutoGen Definitions output"); |
1700 //--------------------------------------------------------------------------- |
1743 //--------------------------------------------------------------------------- |
1701 |
1744 |
1702 //---- |
1745 //---- |
1842 "the parser if not removed.", |
1885 "the parser if not removed.", |
1843 TRUE |
1886 TRUE |
1844 ); |
1887 ); |
1845 cb->addDependency("ENABLE_PREPROCESSING"); |
1888 cb->addDependency("ENABLE_PREPROCESSING"); |
1846 //---- |
1889 //---- |
1847 cl = cfg->addList( |
|
1848 "PRE_INCLUDES", |
|
1849 "The PRE_INCLUDES tag can be used to specify a list of files names that will be\n" |
|
1850 "#include'd before preprocesing any file. The files will be included in the\n" |
|
1851 "order specified by the PRE_INCLUDES tag.\n" |
|
1852 "For example if the PRE_INCLUDES has \"foo.h\" in it this will be treated as if\n" |
|
1853 "#include \"foo.h\" preceeded each input file." |
|
1854 ); |
|
1855 cl->addDependency("ENABLE_PREPROCESSING"); |
|
1856 //---- |
|
1857 cb = cfg->addBool( |
1890 cb = cfg->addBool( |
1858 "PREPROCESS_INCLUDES", |
1891 "PREPROCESS_INCLUDES", |
1859 "If the PREPROCESS_INCLUDES tag is set to YES then doxygen's preprocessor will\n" |
1892 "If the PREPROCESS_INCLUDES tag is set to YES then doxygen's preprocessor will\n" |
1860 "search for all #include'd files according the search paths and feed them to\n" |
1893 "search for all #include'd files according the search paths and feed them to\n" |
1861 "the preprocessor. This means that documentation will be generated for those\n" |
1894 "the preprocessor. This means that documentation will be generated for those\n" |
1862 "#include'd files as well. If set to NO (the default) then the #include\n" |
1895 "#include'd files as well. If set to NO (the default) then the #include\n" |
1863 "statements will be ignored and documentation on #include'd files will only\n" |
1896 "statements will be ignored and documentation on #include'd files will only\n" |
1864 "be generated if they are in the INPUT.", |
1897 "be generated if they are in the INPUT.", |
|
1898 FALSE |
|
1899 ); |
|
1900 cb->addDependency("ENABLE_PREPROCESSING"); |
|
1901 //---- |
|
1902 cb = cfg->addBool( |
|
1903 "PREPROCCESS_FULL_TU", |
|
1904 "If set then Doxygen will always preprocess the complete translation unit for each\n" |
|
1905 "INPUT. This gives a more accurate picture of the contents of the INPUT but may\n" |
|
1906 "take considerably longer to run.", |
1865 FALSE |
1907 FALSE |
1866 ); |
1908 ); |
1867 cb->addDependency("ENABLE_PREPROCESSING"); |
1909 cb->addDependency("ENABLE_PREPROCESSING"); |
1868 //--------------------------------------------------------------------------- |
1910 //--------------------------------------------------------------------------- |
1869 cfg->addInfo("External","Configuration::additions related to external references"); |
1911 cfg->addInfo("External","Configuration::additions related to external references"); |