Ticket #34 (closed task: fixed)

Opened 1 year ago

Last modified 1 year ago

Update VR Juggler 2.2 documentation

Reported by: patrick Assigned to: patrick
Priority: critical Milestone: 2.2
Component: VR Juggler Version: HEAD
Keywords: documentation Cc:
Completion: August 13, 2007

Description

The VR Juggler 2.2 branch will be created soon, and the documentation needs to be updated before the 2.2.0 release. The following are the pieces of documentation that I know need to be updated:

  • VR Juggler Programmer's Guide (VPR API changes, Cocoa topics)
    • I have done quite a bit of work on this already, but I have not committed any of it.
  • VPR Programmer's Guide (API changes)
  • Gadgeteer Device Driver Authoring Guide (VPR API changes)
  • The 2.0 to 2.2 Migration Guide (VPR API changes, Flagpoll, configuration enhancements, versioned installations)
    • This one is nearly done.
  • VR Juggler Getting Started Guide (environment variable updates, Flagpoll, Mac OS X launching)
  • VR Juggler Configuration Guide (configuration enhancements)

Attachments

Change History

04/13/07 08:47:54 changed by patrick

  • status changed from new to assigned.

04/20/07 21:43:38 changed by patrick

The 2.0 to 2.2 Migration Guide is now complete to my satisfaction. Other people are free to add things, of course.

04/22/07 12:39:28 changed by patrick

The VR Juggler Getting Started Guide has been updated for VR Juggler 2.2. The changes were made on the trunk and then merged to the 2.2 branch in Revision 19991.

06/29/07 10:44:49 changed by patrick

  • estimated_completion changed from April 30, 2007 to July 15, 2007.

I just added more information to the Migration Guide to address signature change read/write methods in vpr::BlockIO and the listing of known base types for Gadgeteer device drivers in gadget/Type/InputBaseTypes.h.

06/29/07 16:34:08 changed by patrick

The Gadgeteer Device Driver Authoring Guide is now up to date, as is the associated sample "device driver."

06/29/07 17:40:14 changed by patrick

The VPR Programmer's Guide is up to date. It turned out to be easier than I thought because I already did the updates for threading changes in February 2006.

08/08/07 18:23:31 changed by patrick

  • estimated_completion changed from July 15, 2007 to August 12, 2007.

The VR Juggler Programmer's Guide is nearly up to date. I have the most important parts of the unique and interesting aspects VR Juggler application programming with Cocoa written (though not committed). The only thing left is to document the extension point that allows VRJBasicDelegate to be replaced.

08/13/07 11:09:21 changed by patrick

  • status changed from assigned to closed.
  • estimated_completion changed from August 12, 2007 to August 13, 2007.
  • resolution set to fixed.

All the documentation is up to date now.

Add/Change #34 (Update VR Juggler 2.2 documentation)




Change Properties
Action