DE AutoDoc - Release Notes for DE AutoDoc 1.2.11

04.08.2021: Version 1.2.11

• Corrected the version check in the plugin loader.
• Internal refactorings.

06.02.2021: Version 1.2.10

• Added new tag "includead" to include AutoDoc markup from a file.
• Documentation updated.
• Internal refactorings.

13.05.2020: Version 1.2.9

• Added please wait dialog while loading Plugin list from Plugin repository server.
• Connection and download timeout added for Plugin download in the Plugin manager.
• Compatibility check added while loading Plugins.
• Documentation updated.
• Internal refactorings.

05.04.2020: Version 1.2.8

• For EPUB output the unique ID has been added to the NCX file to make EPUB output more compatible with EPUB standard.
• An entry for *.sql files has been added to "res/AutoDocFileExtensionDefaults.txt".
• The parameter -extdef is now deprecaded and may be removed in future releases. Please use "res/AutoDocFileExtensionDefaults.txt" to configure extension defaults.
• First plugin functionality is implemented.
  • Currently, the plugin functionality is in beta stadium
  • Plugin interface documentation for developers is not yet available
• AutoDoc GUI: Plugin manager added in menu under Configuration -> Plugin Manager. The plugin manager enables to easily install and update AutoDoc plugins.
• Plugins for manual installationare available via http://www.enache.de/en/AutoDoc_Plugins.htm:
  • de.enache.AutoDoc.Plugin.ZippedCode: This plugin can be used as template for own plugins. It enables AutoDoc to process code within a ZIP file (*.zip).
  • de.enache.AutoDoc.Plugin.SAS_EG: This plugin enables AutoDoc to process SAS Enterprise Guide files (*.epg).
• Documentation updated.
• Internal refactorings.

10.02.2019: Version 1.2.7

• Added new command line option "-enablesearch" to enable search functionality in HTML framed output introduced in version 1.2.4.
• Changed templates (in templates directory):
  • Templ_List.htm
  • Treeview.js
• AutoDoc does not try any longer to delete hidden files while cleaning output directory, avoiding to delete system files (eg. "thumbs.db" on Windows systems).
• Bug fixed introduced in version 1.2.5 disabling the search functionality mentioned above.
• Documentation updated.
• Internal refactorings.

01.05.2018: Version 1.2.6

• Global functional index added. This facilitates finding a variable, function, procedure or macro by it's name.
• Detection of global and local bibliography entries improved.
• Documentation updated.
• Internal refactorings.

26.03.2018: Version 1.2.5

• Bibliography functionality added:
  • Sub-Tag "bib" added for adding global bibliography entries.
  • Sub-Tag "bibl" added for adding local bibliography entries.
  • Inline Tag "cite" added to reference bibliography entries defined by the "bib" and "bibl" Sub-Tags.
  • Output of global bibliography from "bib" Tags of the whole project.
• In navigation tree for output types "frames", "iframes", "treeframes", and "itreeframes" an entry "File Index" has been added, pointing to the overview of all files in the project. Also the new bibliography appears, if there are any entries.
• Improved handling of UTF-8 files. Still, when using UTF-8 files, the Byte Order Marker (BOM) must be at the beginning of the file, in order to detect it correctly.
• Documentation updated.
• Internal refactorings.

26.08.2017: Version 1.2.4

• For output types "treeframes" and "itreeframes" an icon image is added at the header of the left navigation area close to the heading to expand and collapse the whole navigation tree. Javascript is required as for the Treeview functionality.
• For output type "frames", "iframes", "treeframes", and "itreeframes" a search is implemented in the output.
  • Search is only implemented for the documentation and not for the original source code.
  • Javascript is required for search.
  • Currently only supported for Firefox (TM) and Internet Explorer (TM) browsers due to security restrictions.
• Changed templates (in templates directory):
  • Templ_List.htm
  • Autodoc.css
  • Treeview.js
• Documentation updated.
• Internal refactorings.

15.07.2017: Version 1.2.3

• Central user defined groups are implemented. The groups are defined in "res/AutoDocUserGroupDefs.txt". This improves the compatibility with Doxygen.
• To a "Fatal Error" message, now a Stack Trace is added, to facilitate debugging.
• GUI: Better detection of already set directories in the directory or file chooser dialogs.
• Documentation updated.
• Internal refactorings.

29.06.2017: Version 1.2.2

• For output type "epub" (Epub E-Books):
  • Better detection of mime types for media type contents of an Epub Ebook.
  • Separate CSS Stylesheet Template "Autodoc_Epub.css" for Epub Ebook format to allow scalable fonts. (The original "Autodoc_Epub.css" can still be used via the -styledef parameter, if fixed fonts are desired.)
• Bug fixed: when the first markup block does not contain a tag escape character ("@" or "\") at the beginning, an IndexOutOfBound exception stopped AutoDoc execution.
• Documentation updated.
• Internal refactorings.

11.05.2017: Version 1.2.1

• An output type for epub E-Books has been added (-outtype "epub"). Epub output is still in beta stadium.
• At the end of the run a summary about errors, warnings and notes is displayed.
• Improved detection of UTF-8 input files. Currently only UTF-8 files with Byte-Order-Mark (BOM) at the beginning of the file are supported because of speed reason.
• Bug fixed: if none of the input files has a gouping tag (like @author, etc.), an IndexOutOfBound exception stopped AutoDoc execution.
• Documentation updated.
• Internal refactorings.

19.11.2016: Version 1.2.0

• AutoDoc main program
  • Two LaTeX output types -outtype "latex" and -outtype "pdflatex" has been added. LaTeX output is still in beta stadium.
  • Parameter -css has been replaced by -styledef. The old parameter -css is still working, but a warning message is issued.
  • Since version 1.0 a File Tag with the filename as first parameter was deprecated. Now, the support for this special case has been removed.
  • Relative paths in "@directory" tag are supported now.
  • Bug fixed: Illegal tag at the beginning of the file led to program abort. Now, program finishes correctly.
  • Bug fixed: @link Sub-Tag did not work properly inside a functional tags description.
  • If the description of an @includes tag is empty it is taken from the included file, if present in the project.
  • Output of settings improved.
  • Output of usage internationalized.
• AutoDoc GUI
  • GUI has a new menu entry "Configuration -> GUI properties" to change GUI settings.
  • GUI internationalized.
  • GUI is converting the -css parameter automatically to -styledef when saving the configuration.
  • GUI output to log window with fixed font width for optical reasons.
  • GUI bug fixed: when working directory does not exist, the loading of settings aborted.
  • GUI shows working directory in red, if the directory does not exist.
  • GUI handles not saved changed settings better.
  • GUI asks to save changed settings before exiting.
• Documentation updated.
• Internal refactorings.

19.03.2016: Version 1.1.3

• New Sub-Tags:
  • @requestor
  • @directory
  • @hiddengroup
  • @changes
  • @chgreason
  • @testdoc
  • @department
• New categories in the tree view on the left:
  • File Properties (for "@status", "@classification", and "@permission" tags)
  • Organizational Entity (for "@company" and "@department" tags)
• New functional tag "@sasrlibname" for remote libnames. Output is split into local and remote libnames.
• For the "@directory" tag, a link to the directory is added on the output, if a directory exists.
• For the "@saslibname" tag, a link to the directory is added on the output, if a directory exists.
• Treeview groupings enhanced, by using new groupings definition file "AutoDocGroupings.txt".
• Possibility to overwrite a "AutoDocDictionary.txt" entry, without having to uncomment the original entry, introduced.
• Some warning / message texts enhanced.
• Using "|" in the -extdef parameter on Windows systems sometimes leads to problems, Windows interpreting it as a pipe. Now "|" can be masked by "^|".
• Output of links in Includes corrected for "-outtype single".
• Output of Groupings also for "-outtype single" and "-outtype noframes". Heading changed from "Index" to "Index by Category".
• New part "Part IV Extending AutoDoc for Experts" added to the documentation.
• Documentation updated.
• Internal refactorings.

15.12.2015: Version 1.1.2

• New sub-tags "@user", "@classification", "@permission" and "@company" added. The "@user" tags works like "@author" and adds the users to the persons list in the Treeview navigation.
• Matlab and Julia programming languages added to Extension defaults list.
• Crash when encountering tags for special lists without parameter fixed. A warning is now issued, when leaving those tags empty.
• Documentation updated.
• Internal refactorings.

09.11.2015: Version 1.1.1

• If details or Sub-Tags are provided for Structural tags, like "@progsection" or "@step", now also a details section for those elements is generated.
• Source code can now be quoted without including it in the AutoDoc markup by placing it between "@beginsrcquote" and "@endsrcquote" Sub-Tags. See Documentation section "Source Code Quoting" for an example.
• Documentation updated.
• Internal refactorings.

06.09.2015: Version 1.1.0

• New functional tag "@saslibname" added for SAS libnames. They are output in the same section as functions and variables, but separately.
• "-extdef" parameter now allows the use of "#" instead of "*", since Java 1.4 has a bug concerning the usage of "*" in command line parameters.
• If an unknown parameter is given on the command line, a warning message is displayed.
• Documentation updated.
• Internal refactorings.

02.07.2015: Version 1.0.22

• Jar file "Autodoc.1_0_x.jar" has been renamed to "AutoDoc.jar" to prepare for major release change.
• Jar file "AutoDocGUI.1_0_x.jar" has been renamed to "AutoDocGUI.jar" to prepare for major release change.
• For .BAT and Fortran files, the removal of the border around comments did not work properly. Corrected and Block End for .BAT files changed from "!*" to "*!". Likewise the Block Begin for Fortran programs has been changed from "C *!" to "C !*".
• Truncation of @author, @reviewer, @tester, and @client entries for the grouping introduced in 1.0.21 improved.
• Quotes are preserved in Inline-Tags, if they don't have require more than 1 parameter (eg. "@code").
• New inline tags "{@q}" for single quote and "{@qq}" for double quote added.
• Improved handling of white space around inline tags.
• Documentation updated.
• Internal refactorings.

19.04.2015: Version 1.0.21

• New Sub-Tag "@client" added for information about the client. It is also shown in the grouping "Persons" on the left side of the "frames", "iframes", "treeframes" and "itreeframes" output.
• Processing of single tag characters (@ and \) and illegal tags improved.
• Documentation updated.
• Internal refactorings.

12.04.2015: Version 1.0.20

• Bug corrected: if the -ext parameter was empty, the extensions defaults were not applied correctly.
• Bug corrected: sometimes an -exclude pattern was not applied correctly.
• Hidden files and directories are skipped from processing now.
• New Sub-Tags "@reviewer" and "@tester" added. The old tag "@checker" is now defined as alias of "@reviewer".
• The following additional groupings have been added to the left navigation side in the "frames", "iframes", "treeframes" and "itreeframes" output:
  • Status (as defined by the "@status" tag)
  • Persons (as defined by the "@author", "@reviewer", and "@tester" tags)
  • Programming language (as determined by the file name extension and the defaults file)
• HTML output character set changed to UTF-8 encoding to enable at least rudimentary foreign language output.
• The parameters -ext and -extdef are now more tolerant, how extensions can be written. if the extensions entered by the user contain "*" or "." they are removed to get the pure extension.
• Documentation updated.
• Internal refactorings.

06.04.2015: Version 1.0.19

• Output type "itreeframes" is now the default output type.
• Minimize button added to the Run dialog of the AutoDoc GUI.
• Windows Installer slightly improved to remember settings from previous installation. Re-Install shortcut added to start menu in case the Java directory changes.
• Documentation updated.
• Internal refactorings.

29.03.2015: Version 1.0.18

• New Sub-Tag "@status" added to be able to add status information.
• Unknown files in output directory are not deleted anymore to avoid deleting user data. Instead a note is displayed, so that the user can take care of the file.
• If the output directory is also an input directory, AutoDoc is terminated with an error message, to avoid deleting input data accidentally.
• Windows Installer modified to automatically detect the Java directory. This is necessary, because since Java 1.8 the Java executable in the \Windows\system32 folder is no longer updated, leading to an error message when launching the AutoDoc GUI from the program menu or desktop shortcut.
• Documentation updated.
• Internal refactorings.

15.03.2015: Version 1.0.17

• New Sub-Tag "@checker" added to be able to specify the code reviewer and tester additional to the author.
• New Inline-Tag "@img" adds images to the documentation.
• New parameter -recurse added, to allow suppressing the recursive processing of input directories.
• GUI Window size slightly adjusted and tested with the 800x600 resolution.
• Documentation updated.
• Internal refactorings.

04.03.2015: Version 1.0.16

• Improved output of @code tag. For block code, now indentation is possible.
• Added check, if -workdir directory exist. If it does not exist, AutoDoc is terminated with an error message.
• Added extension defaults for *.nsi (NSIS Intaller Script) and for *.bat (DOS / Windows batch files).
• GUI button "Edit" has not been enabled, when selecting an item in a list dialog. This has been fixed.
• GUI window size reduced for non HD displays. Should work fine now for display sizes above 800x600, but testing was only possible for 1024x768 and above.
• Windows installer added.
• Documentation updated and frequently asked questions added.
• Documentation corrected: removed parameters -blockbegin and -blockend were still in the text.
• Support E-Mail address is now: AutoDoc@Enache.de
• Internal refactorings.

07.02.2015: Version 1.0.15

• Beta version of a graphical user interface (GUI) introduced (AutoDocGUI_1_0.jar). See documentation for details.
• New parameter -workdir added to change the system's current working directory for the AutoDoc run.
• New inline tags added, mainly because nesting of inline tags is not possible:
  • @u (underline)
  • @s (strike through)
  • @bi (bold italic)
  • @tti (typewriter italic)
  • @ttb (typewriter bold)
  • @ttbi (typewriter bold italic)
  • @bu (bold underline)
  • @biu (bold italic underline)
  • @ttu (typewriter underline)
  • @ttiu (typewriter italic underline)
  • @ttbu (typewriter bold underline)
  • @ttbiu (typewriter bold italic underline)
  • @eu (emphasized underline)
  • @bs (bold strike through)
  • @bis (bold italic strike through)
  • @tts (typewriter strike through)
  • @ttis (typewriter italic strike through)
  • @ttbs (typewriter bold strike through)
  • @ttbis (typewriter bold italic strike through)
  • @es (emphasized strike through)
• Output of paragraphs within Sub-Tags has been improved. Also, if a Sub-Tag only has one parameter, it is not output in a table anymore.
• Grouping of sub-tags improved.
• CSS settings for Sub-Tag parameters have been modified to avoid ugly word wrapping in newer Firefox(TM) browser versions.
• New CSS class "subtag" added to template Autodoc.css.
• Null pointer exception fixed, when an unknown tag is found having no parent tag.
• Message texts and AutoDocTagDictionary updated in "res" sub-directory.
• Documentation updated.
• Documentation corrected: -jar parameter was missing in the example calls.
• Internal refactorings.

04.01.2015: Version 1.0.14

• Bug with program abortion when no extension (-ext) is specified has been corrected.
• Internal refactorings.

31.12.2014: Version 1.0.13

• Bug in output with -single option corrected. Some of the cross reference links did not work properly.
• External links are now opened in a separate browser window.
• A simple index has been added to the CHM index file *.hhk.
• Improved matching of @calls by searching complete include tree and finding the best match.
• Internal refactorings.

29.12.2014: Version 1.0.12

• New sub tag @module added.
• New inline tag {@newline} added.
• In frames output types (frames, iframes, treeframes, itreeframes), the list of packages/namespaces/modules are also output as a tree, similar to groups.
• Detection of matching functionals in "@calls" tag improved. Number and (if applicable type) of functional parameters and name should match. Parameter names are ignored.
• Internal links to function, methods, and macros via {@link } improved.
• Output of sub tags wrapped in HTML div with class set to tag name. This enables defining CSS stylesheets to format each sub tag output differently.
• Notation in C++ with "Classname::Methodname" is now supported in functional tags. It should only be used, when also a "@class" tag is defined in the CPP file.
• New parameter -chm for the output of Microsoft HTML Help Compiler project files for the creation of CHM files.
• Output of progress percentages only, if more than 10 files are in the project.
• Default block begin marker for programming language R changed from "#!*" to "#*!".
• Output message texts changed to correspond better with documentation.
• HTML documentation is now in sub folder "Documentation/html" and a CHM documentation can now be found in "Documentation/chm".
• Internal refactorings.

23.11.2014: Version 1.0.11

• New parameter "-exclude", where exclude patterns of files can be specified to exclude files and / or directories from being processed.
• New parameter "-extdef", where standard settings of the file extension defaults file (res/AutoDocFileExtensionDefaults.txt) can be changed. For details, see documentation.
• Parameters "-blockbegin" and "-blockend" are removed. Please use new parameter "-extdef" instead.
• Parameters set in the configuration file are not to be enclosed in quotes anymore.
• Quoting character defined for the programming languages in extension defaults file, enabling to use a single quote for programming languages as Smalltalk.
• If unsupported tags are encountered, a warning is issued and the tags are treated as normal text and displayed.
• For the output of the "@calls" tag, now a link is added, if the function, method, macro, etc. has been found in the project. Currently, the detection is not tolerant for minor differences. This experimental feature will be improved in the future.
• Vertical alignment for table cells corrected in Autodoc.css.
• While processing, only the processed directories and not the processed filenames are output to the standard output. This reduces the amount of output, while processing a huge amount of files.
• While writing output files, the percentage of processed files are written to the standard output in 10% steps, to be able to monitor the progress.
• If the message texts in a user supplied resource directory ("-res" parameter) is out of synch with the programs internal message text file an error message is displayed and the program finished.
• If the tag dictionary in a user supplied resource directory ("-res" parameter) is out of synch with the programs tag dictionary a warning is displayed.
• Corrections in the documentation.
• Internal refactorings.

19.10.2014: Version 1.0.10

• Structural tag @step has now only one parameter.
• Output of structure is now a list and not a table. The complete include tree is displayed, avoiding circular includes.
• Experimental status of "@calls" tag removed. Syntax remains.
• Documentation updated.
• Internal refactorings.

12.10.2014: Version 1.0.9

• New parameter "-logo" for a logo image added. This way it is possible to incorporate a company logo into the header of the documentation.
• New types for -outtype possible:
  • iframes: same as frames, but iframes are used instead of regular frames (template file: Templ_IFrames.htm).
  • itreeframes: same as treeframes, but iframes are used instead of regular frames (template file: Templ_IFrames.htm).
• New functional tag "@procedure" for procedures added (for SAS PROCS please use "@step").
• Sub-Tag "@calls" marked as experimental. Syntax my change in later releases.
• Type added to output of variable and function summaries.
• New sub tag "@section" for user defined sections.
• Former functional tag "@step" is now defined as a structural tag.
• Parsing markup blocks improved.
• More tolerant parsing regular comments and regular comments in markup comment blocks.
• Main routine returns error level (0 = no error occurred, -1 = an error occurred.).
• Resolution of relative quantifiers . and .. in absolute pathnames.
• If file system is case insensitive, include file detection is also case insensitive.
• Added an file extension defaults file in the "res" directory, defining reasonable defaults for programming languages (if -blockbegin and -blockend are empty). This changes the default behavior of -blockbegin and -blockend.
• Example Autodoc.ini in build directory contains now reasonable defaults.
• Extended the test cases.
• Updated documetation.
• Internal refactorings.

21.09.2014: Version 1.0.8

• New parameter "-res" to specify replacement of the AutoDoc resource directory (where AutoDocTagDictionary.txt and locale specific files are located). This enables used specific tag dictionaries.
• Resolution of ".." in links of includes.
• New functional tag "@format" for format definitions.
• New Sub-Tags "@outpath" and "@outfile" added.
• Parsing single line markup blocks improved.
• Internal refactorings.

06.09.2014: Version 1.0.7

• Markup block detection is now more robust for different comment framing.
• Bug with files containing only one single markup block is corrected.
• Added links to structure output of classes.
• Added links to structure output of includes, when corresponding files are found in the other input files.
• Separate designs for structure output are defined in Autodoc.css.
• Internal refactorings.

25.08.2014: Version 1.0.6

• New functional tag @step for SAS steps or similar concepts (experimental).
• Variables, functions, methods, macros, etc. are now sorted in the output.
• Bug corrected: In some cases, the output directory was not created, if it didn't exist.
• Details heading will not be output anymore, when there are no functions, methods, macros, etc. to output details for.
• Internal refactorings.

23.08.2014: Version 1.0.5

• Cross reference links have been made shorter for better compatibility with different programs.
• Improved tag detection. When the tag character was a backslash, UNC network paths (e.g. \\SERVER\Dir) caused a warning message.
• When first tag start immediately in the first line, it is now correctly detected. Also one line markup blocks are now processed correctly.
• Internal refactorings.

27.07.2014: Version 1.0.4

• Class description added in output and methods and variables grouped by class.
• Removed redundant part of cross reference link output to make them a little shorter.
• Quotes inside inline tags are now supported.
• New command line parameter -locale introduced to enable international output.
• Command line parameter -tagchar has been removed, it is automatically detected for each file from the two symbols "@" or "\".
• Doxgen(TM) compatibility changes:
  • Tag @include renamed to @includes
  • Tag @section renamed to @progsection
• New structure tags:
  • @interface
• New sub tags:
  • @attention
  • @example
  • @namespace
  • @note
  • @precond
  • @postcond
  • @docu
  • @brief (for Doxygen (TM) compatibility only)
  • @details (for Doxygen (TM) compatibility only)
• Aliases for Doxygen (TM) compatibility introduced:
  • @headerfile (@library)
  • @fn (@function)
  • @var (@variable)
  • @authors (@author)
  • @returns, @retval (@return)
  • @sa (@see)
  • @throw (@throws)
  • @addtogroup, @defgroup, @ingroup, @weakgroup (@group)
  • @pre (@precond)
  • @post (@postcond)
  • @short (@brief)
  • @ref (@link)
  • @a (@i)
  • @c, @p, @verbatim (@tt)
  • @e (@em)
• Testcases adapted.
• Tag dictionary placed in a file instead of hard coded. This prepares a future localization / internalization of the output.
• Major internal refactorings.

20.05.2014: Version 1.0.3

• HTML templates "Templ_File.htm", "Templ_Index.htm", "Templ_List.htm" and "Templ_Frames.htm" are used now for output instead of a hard coded design. This supports user defined templates better.
• User defined ressources in the template's sub folder "res" are automatically copied to the output directory to support user defined templates.
• Item lists in a tag's description are now supported.
• File tags syntax changed. The first parameter (the filename) is obsolete now. For compatibility with older versions is is an optional parameter.
• New sub tags:
  • @copyright
  • @bug
  • @precond
  • @duration
  • @freq
• New inline tags:
  • {@b bold text}
  • {@i italic text}
  • {@em emphasized text}
  • {@tt true type text}
• Internal Refactorings.

02.05.2014: Version 1.0.2

• New tags @package and @subprogram added.
• New inline tag @extlink added in order to change the @link tag to be compatible with Javadoc.
• Internal links using the @link tag are now possible.
• Internal Refactorings.

18.04.2014: Version 1.0.1

• Bug with repeatedly inserted header insert file fixed.
• Bug with case sensitive extensions has been corrected. They are now case insensitive.
• Internal Refactorings.
• Left sided borders in markup blocks enabled.
• Documentation extendended.

13.04.2014: Version 1.0.0

• Compatible with older Java versions (JRE 1.4 and above), which is important for the usage in companies.
• No additional libraries are included, which is important for placing all under the GPL licence.
• Currently only the language English is supported, other languages will follow.