Project

General

Profile

Bug #4908

actor/director/attribute .xml file documentation needs to be updated

Added by Christopher Brooks about 9 years ago. Updated almost 7 years ago.

Status:
New
Priority:
Normal
Assignee:
Category:
documentation
Target version:
Start date:
03/29/2010
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
4908

Description

The kar files include documentation for actors, directors and attributes.

These files need to be checked against the corresponding Ptolemy
actors, directors and attributes and updated accordingly.

For example, the directors/resources/kar/CoreDirectors/PNDirector.xml
file did not include information from June, 2008 about how to stop
a PN model.

To fix this bug, all of the .kar files should be reviewed and compared
with the original class comments in the .java files.

History

#1 Updated by Christopher Brooks almost 7 years ago

The actor documentation should be reviewed and updated before 2.4.0.

#2 Updated by Daniel Crawl almost 7 years ago

I'm working on this in conjunction with 5529.

#3 Updated by Daniel Crawl almost 7 years ago

I added a new ant target to update the documentation: ant update-actor-doc. Individual kar files can also be updated with kepler.sh:

./kepler.sh -updateActorDocs actors/resources/kar/CoreActors/Ramp.xml

The kar documentation is updated from the source file javadocs. Before I check in the new documentation to svn, it would be good if at least one other person ran "ant update-actor-doc" and reviewed the changes.

#4 Updated by Ilkay Altintas almost 7 years ago

A future RFE needs to be issued for a future release to combine the forked pieces. Dan investigated the technical parts and it is possible to combine, but everything seems to be different from documentation point of view. Matt says the new solution still needs to allow for iterative increments of an actor (e.g. R docs apply for statistical R actors) which wasn't in Ptolemy at that time.

#5 Updated by Ilkay Altintas almost 7 years ago

PN needs to be updated for 2.4.

#6 Updated by Daniel Crawl almost 7 years ago

The Kepler documentation for PN was updated in 2010 with the information on how to stop the model:

----
r23513 | brooks | 2010-03-29 14:07:32 -0700 (Mon, 29 Mar 2010) | 2 lines

Added documentation about how to terminate a PN model.
----

In the last 2.4 release meeting, we decided that adding the information on how to stop the model was the only task for this bug for 2.4. I'm retargeting to a future release to reconcile the documentation.

#7 Updated by Redmine Admin about 6 years ago

Original Bugzilla ID was 4908

Also available in: Atom PDF