Projects tagged ‘documentation’ and ‘javadoc’

A complete documentation solution for PHP. Generates javaDoc-style API documentation and user-level manuals from your PHP code. phpDocumentor uses an extensive templating system to change your source ... [More] code comments into human readable, and hence useful, formats. This system allows the creation of easy to read documentation in 15 different pre-designed HTML versions, PDF format, [Less]

Epydoc is a tool for generating API documentation for Python modules, based on their inline documentation strings (docstrings). It produces HTML output (similar to the output produced by Javadoc) and ... [More] LaTeX output. It supports four markup languages for documentation strings: Epytext, Javadoc, ReStructuredText, and plain text. [Less]

APIviz is a JavaDoc doclet which extends the Java standard doclet. It generates comprehensive UML-like class and package diagrams for quick understanding of the overall API structure.

Set of JavaDoc doclets that allow you to generate documentation for your Java APIs for: JAX-RS: the RESTful Java API JAXB: the XML Java binding Many more will come (JPA, Bean Validation, Hibernate ... [More] Search, Envers…) The full documentation is located on Lunatech Research’s open source website. [Less]

JDiff is an LGPL Javadoc doclet 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 ... [More] documentation, when two APIs are compared. This is very useful for describing exactly what has changed between two releases of a product. Only the API (Application Programming Interface) of each version is compared. It does not compare what the source code does when executed. [Less]

VBDOX is a simple program that generates technical documentation from source comments. The only requirement is to use specific module and function comments format. Documentation is generated for all ... [More] types Visual Basic files and also for VBScript and ASP (limited support) The program can be extended to support different documentation comments and reports. Right now the program has three report generators: single file, XML and MSDN Platform SDK style. The report appearance can be edited by changing either the style sheets or the report files. Number of documentation comment parser is supplied at the moment. [Less]

JCite cites snippets of Java source code or Excel sheets into HTML documents – API documentation, for instance. Citing from tests, or tested code, guarantees that your examples really work. And they get automatic syntax highlighting.

Last update, 25.10.2009. Read more on the News. AboutBDoc documents behaviour specified by unit tests. In its easiest form it is like TestDox, creating simple documentation from the method names in ... [More] JUnit test cases. In its more advanced form it can produce a quality report, describing userstories and behaviour implemented by the code. This will give extra value to the developers and testers of the team. It will contribute on giving attention to unittesting, test-driven development and behaviour-driven development. By showing the report to the business people and testers the developers will get feedback on how they describe the domain, which contributes to code (and developers) being in sync with the UbiquitousLanguage of the project. A quality report giving value can be achieved by adding some thought to how a test is named, writing it as sentence describing behaviour. DanNorh.net gives an excellent article on this topic. If user stories is used on the project it is also possible to reference the user story from the test, adding even more value to the end report. BDoc will structure a report by userstories, specifications and examples. The best documentation are as always examples, so look below. Read more about BDoc on TheServerSide.com ExampleThe code below describes and tests the behaviour of an ExecutiveOfficer. The testcase uses a Reference to a Story, one scenario, one statement and a few specifications. Running BDoc on this code, together with testcases for Task and TaskList, will produce the report shown below. BDoc now requires a tiny bdd-framework in order to extract example data. The framework (or the class if you like) must be implemented by your project, in the relevant language. BDoc needs this construction in order to inject proxies into the test, while it is running, analyzing method calls and data for the report. package com.googlecode.bdoc.examples.taskhandling; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; import java.util.ArrayList; import java.util.List; import org.junit.Test; @Ref(Story.TASKTRACKING) public class TestExecutiveOfficerBehaviour extends ExampleSupport { private ExecutiveOfficer currentOfficer; private Task currentTask; @Test public void aNewExecutiveOfficerShouldNotHaveAnyTasksInHisOrHerTaskList() { ExecutiveOfficer officer = new ExecutiveOfficer("Bob"); assertTrue(officer.getTaskList().getList().isEmpty()); } @Test public void defaultAssignmentOfTasksIsToTheCreatorOfATask() { given.officer(new ExecutiveOfficer("Bob")); when.theOfficerCreatesATaskWithDescription("*Register salesorder*"); then.ensureTheTaskIsAssignedToTheOfficer(currentOfficer); } void officer(ExecutiveOfficer officer) { this.currentOfficer = officer; } void theOfficerCreatesATaskWithDescription(String description) { currentTask = currentOfficer.createTask(description); } void ensureTheTaskIsAssignedToTheOfficer(ExecutiveOfficer officer) { assertTrue(officer.isAssignedTo(currentTask)); } @Test public void aTaskShouldBeMarkedWithInprogressWhenItIsStartedByAnExecutiveOfficer() { ExecutiveOfficer officer = new ExecutiveOfficer("Bob"); Task task = officer.createTask("Register salesorder"); officer.start(task); assertTrue(task.getInProgress()); } @Test public void aClosedTaskShouldBeRemovedFromTheTasklist() { given.officer(new ExecutiveOfficer("Bob")); and.theOfficerCreatesATaskWithDescription("*Register salesorder*"); and.theOfficerStartsTheTask(currentTask); when.theOfficerClosesTheTask(currentTask); then.ensureTheTaskIsRemovedFromTheExecutiveOfficer(currentOfficer); } void theOfficerStartsTheTask(Task task) { currentOfficer.start(task); } void theOfficerClosesTheTask(Task task) { currentOfficer.close(task); } void ensureTheTaskIsRemovedFromTheExecutiveOfficer(ExecutiveOfficer officer) { assertFalse(officer.getTaskList().getList().contains(currentTask)); } @Test public void shouldHaveAnEstimatedEtcEqualToTheSumOfTasksAssigned() { given.officer(new ExecutiveOfficer("Bob")); and.theOfficerIsAssigned(tasksForHandlingAStandardSalesOrder()); then.ensureEstimatedEtcInMinutesEquals(12); } void theOfficerIsAssigned(List tasks) { currentOfficer.assign( tasks ); } List tasksForHandlingAStandardSalesOrder() { List list = new ArrayList(); list.add(new Task("Register salesorder",4)); list.add(new Task("Check stock",2)); list.add(new Task("Print and finish order",6)); return list; } void ensureEstimatedEtcInMinutesEquals(int expectedEtc) { assertEquals(expectedEtc, currentOfficer.getTaskList().getEtc()); } }Report generated by BDoc: [Less]

This project aims to create new presentation template for Sandcastle that will generate documentation in the style of MSDN Lightweight branding. Sample of rendering StoredNumber class from test.cs ... [More] (part of Sandcastle examples) as of 21. Nov 2009: Full image Support for JavadocCustom XmlDoclet for Javadoc can generate required doc and reflection XML documents for Java sources: Full image [Less]