Doclet programs work with the Javadoc tool to generate documentation from code written in Java programming language Java . Doclets are written in the Java programming language and use the doclet API to Select which content to include in the documentation. Format the presentation of the content. Create the file that contains the documentation. The standard doclet included with Javadoc generates API documentation as frame based HTML files. Many non standard doclets are available on the web, often for free. These can be used to Create other non API types of documentation. Output the documentation to other non HTML file types such as PDF . Output the documentation as HTML with additional features such as a search or with embedded Unified Modeling Language UML diagrams generated from the Java classes. External links http java.sun.com j2se 1.4.2 docs tooldocs javadoc overview.html http www.doclet.com Overview of available non standard doclets. http www.yworks.com ydoc UML Doclet Java Sun Sun Microsystems FOSS Category Java programming language de Doclet es Doclets ... more details
JDiff is a Javadoc doclets which generates an HTML report of all the packages, classes, constructors, methods, and fields which have been removed, added or changed in any way, including their documentation, when two Java programming language Java API s are compared. This is very useful for describing exactly what has changed between two releases of a product. Only the API of each version is compared. It does not compare what the source code does when executed. External links http javadiff.sourceforge.net JDiff homepage http javadiff.sourceforge.net jdiff reports j2se140 j2se141 changes.html A sample report resembles Javadoc reports DEFAULTSORT Jdiff Category Documentation generators Category Java development tools ... more details
merge to AspectJ date October 2011 AspectWerkz is a dynamic, lightweight and high performance Aspect oriented programming AOP AOSD framework for Java programming language Java . It has been merged with the AspectJ project, which supports AspectWerkz functionality since AspectJ 5. Unlike AspectJ prior to version 5, AspectWerkz did not add any new language constructs to Java, but instead supported declaration of aspects within Java annotations. It utilizes bytecode modification to weave classes at project build time, class load time, as well as runtime. It uses standardized JVM level APIs. Aspects can be defined using either Java 5 annotations, Java 1.3 1.4 custom doclets or a simple XML definition file. AspectWerkz provides an API to use the very same aspects for proxies, hence providing a transparent experience, allowing a smooth transition for users familiar with proxies. AspectWerkz is Free Software. The LGPL style license allows the use of AspectWerkz 2.0 in both commercial and open source projects. External links http aspectwerkz.codehaus.org Project homepage Category Aspect oriented programming Category Java APIs Category Java libraries http aspectwerkz.codehaus.org introduction.html compu lang stub ... more details
JSDoc is a syntax for adding inline Application programming interface API documentation to JavaScript source code. This is distinct from the various tools that parse and manipulate code that follows the JSDoc syntax . The JSDoc syntax is similar to the Javadoc syntax, used for documenting Java code, but is specialized to work with JavaScript s more dynamic syntax and therefore unique, as it is not completely compatible with Javadoc. However, like Javadoc, JSDoc allows the programmer to create doclets and tags which can then be translated into published output, like HTML or RTF . JSDoc tags Although this list is incomplete, the following annotations are commonly used in modern JSDoc. class wikitable Tag Description author Developer s name constructor Marks a function as a constructor deprecated Marks a method as deprecated exception Synonym for throws param Documents a method parameter a datatype indicator can be added between curly braces private Signifies that a method is private return Documents a return value see Documents an association to another object this Specifies the type of the object to which the keyword this refers within a function. throws Documents an exception thrown by a method version Provides the version number of a library Example An example of JSDoc usage. source lang javascript Creates an instance of Circle. constructor this Circle param number r The desired radius of the circle. function Circle r private this.radius r private this.circumference 2 Math.PI r Creates a new Circle from a diameter. param number d The desired diameter of the circle. return Circle The new Circle object. Circle.fromDiameter function d return new Circle d 2 Calculates the circumference of the Circle. deprecated this Circle return number The circumference of the circle. Circle.prototype.calculateCircumference function return 2 Math.PI this.radius Returns the pre computed circumference of the Circle. this Circle return number The circumference of the circle. Circle.proto ... more details
Encyclopedia
top
