Bug #5715: Actor Reference documentation - Kepler - Ecoinformatics Redmine

Actions

Copy link

Bug #5715

open

Actor Reference documentation

Added by jianwu jianwu over 11 years ago. Updated about 11 years ago.

Status:

New

Priority:

Normal

Assignee:

jianwu jianwu

Category:

documentation

Target version:

2.X.Y

Start date:

09/19/2012

Due date:

% Done:

Estimated time:

Bugzilla-Id:

5715

Description

this doc hasn't changed since 2.0, but in 2.4, many actors are visible for the first time. So we might need to update this doc.

435 pages.

Related issues

Actions

Copy link

Updated by Christopher Brooks over 11 years ago

To update the actor documentation:
cd build-area
ant update-actor-doc

Actions

Copy link

Updated by Daniel Crawl over 11 years ago

The actor reference manual is at https://code.kepler-project.org/code/kepler-docs/trunk/outreach/documentation/shipping/ActorReference.pdf.

(In reply to comment #1)

To update the actor documentation:
cd build-area
ant update-actor-doc

This ant target uses javadoc to update the XML files in <module>/resources/kar/... from the source code. These docs are shown in the DocViewer in Kepler.

The actor reference manual was assembled by hand using the text in these XML files, and possibly edited. Since then (2008, Kepler 1.0) the XML files have been updated and new actors added. It would be nice to automatically generate this manual, but may not happen for the 2.4 release.

Actions

Copy link