Project

General

Profile

Bug #5715

Actor Reference documentation

Added by jianwu jianwu about 7 years ago. Updated over 6 years ago.

Status:
New
Priority:
Normal
Assignee:
Category:
documentation
Target version:
Start date:
09/19/2012
Due date:
% Done:

0%

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

Blocked by Kepler - Bug #5625: create kepler documentation for 2.4Resolved06/15/2012

History

#1 Updated by Christopher Brooks about 7 years ago

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

#2 Updated by Daniel Crawl almost 7 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.

#3 Updated by Daniel Crawl over 6 years ago

Postponing to future release.

#4 Updated by Redmine Admin over 6 years ago

Original Bugzilla ID was 5715

Also available in: Atom PDF