![]() ![]() \n" 42 + "# This could be handy for archiving the generated documentation or \n" 43 + "# if some version control system is used.\n",Ĥ8 "# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) \n" 49 + "# base path where the generated documentation will be put. See \n" 30 + "# for the list of possible encodings.\n",ģ5 "# The PROJECT_NAME tag is a single word (or a sequence of words surrounded \n" 36 + "# by quotes) that should identify the project.\n",Ĥ1 "# The PROJECT_NUMBER tag can be used to enter a project or revision number. ![]() Doxygen uses libiconv (or the \n" 29 + "# iconv built into libc) for the transcoding. The default is UTF-8 which is also the encoding used for all \n" 28 + "# text before the first occurrence of this tag. 21 */ 22 package .doxygen Ģ6 "# This tag specifies the encoding used for all characters in the config file \n" 27 + "# that follow. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. You may obtain a copy of the License at 13 * 14 * 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 * The ASF licenses this file to You under the Apache License, Version 2.0 11 * (the "License") you may not use this file except in compliance with 12 * the License. See the NOTICE file distributed with 9 * this work for additional information regarding copyright ownership. The -all switch means to compile all configurations we actually need only HTML Help configuration, but I have not found how to compile it alone, so I compile them all.Īfter executing collections.bat we obtain a very attractive help file Collections.View Javadoc 1 /** 2 * The Doxygen Maven Plugin (dmp) 3 * 4 * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 by SoftwareEntwicklung Beratung Schulung (SoEBeS) 5 * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 by Karl Heinz Marbaise 6 * 7 * Licensed to the Apache Software Foundation (ASF) under one or more 8 * contributor license agreements. “c:\Program Files\Doc-O-Matic 7 Express\domexpress.exe” -all c:\Work\Collections\DoM700\Collections.dox-express To perform the compilation in a single click create a batch file collections.bat with a single text line like this: Now we should use command-line documentation generator to create compiled HTML help file. We have created DoM project with necessary settings. Save the DoM project in DoM700 subdirectory under the name “Collections” and exit Doc-O-Matic Express Configuration utility. On the “Help Project Option” check “Create binary TOC” checkbox: The path to help compiler should already be set if help compiler is installed in your system most probable it is installed already if not download and install “HTML Help Workshop” from Microsoft – it is free: Now switch to HTML Help Tab on the “HTML Help” panel set the name of *.chm file to be generated. On the “Comment Finding” panel check “Use triple comments only” checkbox: On the “General Options” panel set the project’s title (and other information if you like): Create a new Doc-O-Matic project and add all *.pas files from Source subdirectory to the project: Run the Doc-O-Matic Express Configuration utility. Here is step-by-step instruction how to generate compiled html help using Doc-O-Matic Express 7.0:Ĭreate the following directory structure:Ĭopy the “Collections” package files to the ‘Source’ subdirectory. Using Doc-O-Matic Express one can generate documentation in several help formats in this article we will see how to generate compiled html help (*.chm file).įor the demonstration purposes I downloaded Collections package by Alex Ciobanu the project recently started to use XMLDoc-style in-source documenting comments. There is also free (for non-commercial use) edition – Doc-O-Matic Express that can be downloaded from the official site. In fact I have found the only documentation generator that supports XMLDoc-style for Delphi in-source comments – that is Doc-O-Matic. So we must limit ourselves to the set of XML tags supported by the already available documentation generators. Unfortunately currently there are no documentation generators for Delphi in-source comments that fully support these guidelines. There is also very good Delphi Documentation Guidelines document which describes what XML tags should be used for in-source XMLDoc-style documenting comments and how to use these tags. XMLDoc in-source documentation style is becoming popular among Delphi open-source projects. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |