I have a collection of Java source files that Doxygen is happily processing. Included in the collection is a set of Android Interface Definition Language (AIDL) files, used to specify interfaces. I can't get Doxygen to generate output from these.
I added *.aidl to FILE_PATTERNS, and I can see that doxygen is reading the files --- there's just no output from the contents. The files are valid Java and have Doxygen commands embedded, just like the Java files that are processed.
Does anyone have experience using doxygen to process AIDL files?
To generate the Docs for AIDL files :
GoTo Expert --> Input --> FILE_PATTERNS : add *.aidl so that Doxygen recognizes aidl files
GoTo Expert --> Project --> EXTENSION_MAPPING : add aidl=java to parse similar as java
Related
I am a newbie to doxygen tool. I've followed the doxygen configuration guide for generating a HTML document out of my C# source files. I am able to generate the HTML output, but I identified that it is generating output of the files that exists in the selected source folder only, where as the files present inside the sub directories of the source folder are skipped/ignored. Per help guide, I've checked the "Recursive" option in the wizard. Is there anything still we need to configure?
Could anyone help me out for resolving this issue. Thanks in advance.
Regards
Badri
I am using doxygen to document the contents of my cgi-bin folder on my apache web server. The doxygen html pages have links to source code but they stopped working. Is there a specific expert configuration parameter required?
I am unable to generate javadoc for linked .java files using Eclipse Mars.
This shows how my project is set up:
I am able to run the program.
The source file is in a folder named foo, to match the package declaration:
I select Project > Generate Javadoc... and check the package:
I agree to all of the default options.
I get this output in the console:
Loading source files for package foo...
Constructing Javadoc information...
javadoc: warning - No source files for package foo
javadoc: warning - No source files for package foo
javadoc: error - No public or protected classes found to document.
1 error
2 warnings
Adding javadoc comments to the source code makes no difference.
I have no trouble generating javadoc when I do not have linked source files.
How do I set up links to source files so I can generate javadoc?
When you do Project > Generate Javadoc... it launches the external program javadoc part of the JDK typically. The javadoc program does not understand/know about Eclipse linked resources, so it sees the empty folder.
How do I set up links to source files so I can generate javadoc?
Short answer is you cannot with links at the file level.
Use Links to src folder
Rather than doing a link to files within a package, make the link to the containing source folder. In your screenshot you don't have a src folder, but you could create one that is linked.
For example, I have a project called demoforso, in it I create a folder called src that is linked to D:\tmp\src and add src to classpath. When the javadoc is run on this project, it passes D:\tmp\src as the sourcepath.
Use Javadoc views in Eclipse
(i.e. Don't generate Javadoc at all, granted possibly not useful in your case, but included for completeness.)
The hovers and Javadoc view in Eclipse means that you never need to generated Javadoc for your own use.
my team created a project in Frame Maker and we want to convert it to DITA (that will be edited with Frame Maker). The conversion is done with Mif2go. It is complicated step and the DITA files may contain incomplete information. I was suggested to validate them using Eclipse (Kepler).
The DITA version of the files is 1.1 (the default of Mif2Go). I was needed to copy the DITA library files to eclipse workspace in order to validate the XML (including, for example, bookmap.dtd, bookmap.mod, and more). However, I get many errors for theese files when I validate the workspace of eclipse. For example, in the file "metaDecl.mod", i get error for the line "!ELEMENT author (%words.cnt;)*".
The error says:
" A '(' character or an element type is required in the declaration of element type "author"."
I get this error for many DITA files and I don't understand why.
I will extremely appreciate any clue...
Hard to tell based on your question and without understanding the Mif2go conversion.
I'd start with ensuring you have the Web Tools Platform (www.eclipse.org/webtools) installed in Eclipse. This includes XML validation. You may also want to download the DITA-OT from https://github.com/dita-ot and unzip it to your Eclipse workspace folder and add it as a project.
I am using Eclipse to convert HTML to DITA and validation seems to work OK on my DITA files. It may also be that Mif2go is writing out some bad XML; that .mod file is part of the DITA-OT, so that's probably not the issue. Maybe you can try removing the offending line and trying to validate again.
I think we can all agree, when a developer gets a project out of their source control system... it should successfully build.
Question:
What extraneous files do you omit and which are you certain to add?
Anything that's generated from the items you check into source control.
Things I check in:
Source files (usually .java for me, but can be other languages)
3rd party JARs
Configuration XML or .properties
HTML, CSS, JSPs for web apps
SQL scripts
Design (UML) and documentation (Word or HTML)
Unit test classes and any data I need to run them
Things I don't:
Compiled .class files
Generated JAR or WAR files
javadocs
JUnit report HTML and results
In addition to generated files, in Visual Studio I leave out mstest files (.vsdmi), resharper user files, Visual Studio user files (.suo).
Include information about the database schema (diagram), set up queries and other special config params
My global ignore pattern for TortoiseSVN is: *.vbw *.scc *.vbg */bin */obj *.bak *.user *.suo *.webinfo bin obj *.dll *.pdb *.exe which covers both VB6 and C#.
I always leave out compiled files, which for me are generally of the .pyc variety.