ToDo #59
Fill in RDoc comments in code base and Generate RDoc files
| Status: | Closed | Start: | 12/22/2008 | |
| Priority: | Normal | Due date: | 01/15/2009 | |
| Assigned to: | % Done: | 0% |
||
| Category: | Documentation | Spent time: | 1.75 hours | |
| Target version: | 1.0 Official Release | |||
| Sponsor: |
Description
Fill in RDoc comments in code base and Generate RDoc files
Post the RDoc files publicly somewhere within the mediashelf domain space
Focus on:- ActiveFedora::Model
- has_metadata
- has_relationship
- has_datastream (and why it's not there yet)
- ActiveFedora::Base
- find, find_by_solr
- datastreams
- relationships
- add_datastream
- add_relationship
- save
- ActiveFedora::Datastream
- save
- ActiveFedora::MetadataDatastream
- defining custom fields
- convenience methods for metadata fields
- save
- ActiveFedora::QDCDatastream
- using built-in QDC fields
- defining custom field accessors
Don't bother documenting stuff in the guts.
History
Updated by McClain Looney 541 days ago
- Status changed from In Progress to Ready for Test
rake docs
to generate rdoc html