DE AutoDoc - Frequently Asked Questions

On this page, frequently asked questions from the users are collected. If you encounter serious problems, please feel free to contact AutoDoc@Enache.de.

 

Installation

Q: Why isn't there an installation program for AutoDoc?
A: Only system administrators are allowed to execute installation programs on certain operating systems. In order to enable every user to install AutoDoc, the installation is designed to consist only of unzipping the distribution file. Since Relase 1.0.16 an installation program for MS WindowsTM has been added. For other operating systems an installation program is not planned.

 

Execution Control

Q: What possibilities exist to exclude certain files from being processed?
A: AutoDoc offers many possibilities to control which files are processed and which are not, depending on a given situation.
  • Adjusting the parameter -in may help to select only the files, which should be processed.
  • AutoDoc ignores files, which do not have any markup tag or at least a main file tag.
  • Use the -ext parameter, if you want to process only certain file extensions, e.g. "c, cpp, h, hpp".
  • Use the -exclude parameter, if you want to exclude certain directory or file patterns, like "*\OLD\*".
  • Use the @exclude tag as the main file tag, if you temporarily want to exclude a file from being processed, but want to keep the AutoDoc markup in the file.
  • Since AutoDoc 1.0.17 additionally it is possible to supress the recursive processing of the input directories sub folders using the parameter -recurse "no".
  • Since AutoDoc 1.0.20 hidden files and directories are not processed.
Q: I am using AutoDoc from the command line and want the AutoDoc screen output to be written to a log file instead of the console. Is this possible?
A: AutoDoc console output is written to stdout, so it can be easily redirected to a file using your operating systems piping mechanisms (for example in WindowsTM and Unix-like operating systems by appending " > filename.log" to the AutoDoc call).

 

Conversion

Q: How do I generate a Documentation in MS WordTM format?
A: Use the parameter -outtype "single" to generate a single output file. Then open the Docuemtnation file index.htm with MS WordTM. Finally save as MS WordTM Document. This should also work with similar programs, like Open OfficeTM.
Q: How do I generate a Documentation in MicrosoftTM Help format?
A: Use the parameter -chm "ProjectName" to generate the neccessary project and index files. Then use MicrosoftTM HTML WorkshopTM to generate the CHM file. The program can be downloaded for free from the MicrosoftTM website.

 

Troubleshooting

Q: AutoDoc sometimes mixes up parameters, when I use directory names ending with a backslash (\) on the command line. Is this a bug?
A: This problem only occurs, when the backslash is directly followed by a quote, e.g. -out "output\". This is not a AutoDoc bug. It has something to do with how Java processes command line parameters. When a quote is preceeded by a backslash Java interprets this a quote being escaped. Either remove the ending backslash or insert a space between the backslash and the quote. It is also possible to remove the quotes around the directory, if the directory in question does not contain any spaces.
Q: AutoDoc sometimes replaces "*" in command line parameter by a directory name. Is this a bug? A: This seems to be a bug in Java 1.4 command line processing. Either try using a newer Java Runtime version or try using "#" instead as a workaround. If the workaround does not work, the only possibility is to define the parameter in a configuration file and use that via the "-cfg" parameter.
Q: AutoDoc is so slow, while working on a network drive. Is there a possiblity of speeding it up?
A: In most cases network access is a lot slower than access to a local drive. Especially, if you company uses security measures, like firewalls and anti virus programs. But usually, read access from network drives is faster than write access to network drives. so, you can gain a some speed, by setting the -out parameter to a local drive and then later copying the resulting documentation to the network location.
Q: The CHM documentation does not show properly? AutoDoc is installed on a network drive.
A: The issue here is a Windows security hotfix, blocking all CHM content from non local drives. Fixes can be found on the internet, but they require manipulating the Windows registry, so only system administrators can fix this problem. Either copy the documentation to a local drive or use the HTML documentation instead, if AutoDoc is installed on a network drive.