Improved documentation on the remaining OnXXX functions for custom objects

Changes

4 changed files (+20/-0)

• place.go
  • @@ -280,6 +280,11 @@ }
    type withPlaceFn func(*Place) error + // OnPlace calls function fn on it Item if it can be asserted to type *Place + // + // This function should be called if trying to access the Place specific properties + // like "accuracy", "altitude", "latitude", "longitude", "radius", or "units". + // For the other properties OnObject should be used instead. func OnPlace(it Item, fn withPlaceFn) error { if it == nil { return nil
• profile.go
  • @@ -248,6 +248,11 @@ }
    type withProfileFn func(*Profile) error + // OnProfile calls function fn on it Item if it can be asserted to type *Profile + // + // This function should be called if trying to access the Profile specific properties + // like "describes". + // For the other properties OnObject should be used instead. func OnProfile(it Item, fn withProfileFn) error { if it == nil { return nil
• relationship.go
  • @@ -263,6 +263,11 @@ }
    type withRelationshipFn func(*Relationship) error + // OnRelationship calls function fn on it Item if it can be asserted to type *Relationship + // + // This function should be called if trying to access the Relationship specific properties + // like "subject", "object", or "relationship". + // For the other properties OnObject should be used instead. func OnRelationship(it Item, fn withRelationshipFn) error { if it == nil { return nil
• tombstone.go
  • @@ -254,6 +254,11 @@ }
    type withTombstoneFn func(*Tombstone) error + // OnTombstone calls function fn on it Item if it can be asserted to type *Tombstone + // + // This function should be called if trying to access the Tombstone specific properties + // like "formerType" or "deleted". + // For the other properties OnObject should be used instead. func OnTombstone(it Item, fn withTombstoneFn) error { if it == nil { return nil