Some documentation improvements

Changes

2 changed files (+38/-37)

• src/activitypub/activity.go
  • @@ -1,7 +1,7 @@
    package activitypub + // Activity Types const ( - // Activity Types AcceptType ActivityVocabularyType = "Accept" AddType ActivityVocabularyType = "Add" AnnounceType ActivityVocabularyType = "Announce"
  • @@ -64,7 +64,7 @@ var validActivityTypes = [...]ActivityVocabularyType{
    // Actor Types } - // Instances of IntransitiveActivity are a subtype of Activity representing intransitive actions. + // IntransitiveActivity Instances of IntransitiveActivity are a subtype of Activity representing intransitive actions. // The object property is therefore inappropriate for these activities. type IntransitiveActivity struct { *APObject
  • @@ -89,7 +89,7 @@ type IntransitiveActivity struct {
    Source Source `jsonld:"source,omitempty"` } - // An Activity is a subtype of APObject that describes some form of action that may happen, + // Activity is a subtype of APObject that describes some form of action that may happen, // is currently happening, or has already happened. // The Activity type itself serves as an abstract base type for all types of activities. // It is important to note that the Activity type itself does not carry any specific semantics
  • @@ -104,113 +104,113 @@ type Activity struct {
    } type ( - // Indicates that the actor accepts the object. The target property can be used in certain circumstances to indicate + // Accept indicates that the actor accepts the object. The target property can be used in certain circumstances to indicate // the context into which the object has been accepted. Accept Activity - // Indicates that the actor has added the object to the target. If the target property is not explicitly specified, + // Add indicates that the actor has added the object to the target. If the target property is not explicitly specified, // the target would need to be determined implicitly by context. // The origin can be used to identify the context from which the object originated. Add Activity - // Indicates that the actor is calling the target's attention the object. + // Announce indicates that the actor is calling the target's attention the object. // The origin typically has no defined meaning. Announce Activity - // An IntransitiveActivity that indicates that the actor has arrived at the location. + // Arrive is an IntransitiveActivity that indicates that the actor has arrived at the location. // The origin can be used to identify the context from which the actor originated. // The target typically has no defined meaning. Arrive IntransitiveActivity - // Indicates that the actor is blocking the object. Blocking is a stronger form of Ignore. + // Block indicates that the actor is blocking the object. Blocking is a stronger form of Ignore. // The typical use is to support social systems that allow one user to block activities or content of other users. // The target and origin typically have no defined meaning. Block Ignore - // Indicates that the actor has created the object. + // Create indicates that the actor has created the object. Create Activity - // Indicates that the actor has deleted the object. + // Delete indicates that the actor has deleted the object. // If specified, the origin indicates the context from which the object was deleted. Delete Activity - // Indicates that the actor dislikes the object. + // Dislike indicates that the actor dislikes the object. Dislike Activity - // Indicates that the actor is "flagging" the object. + // Flag indicates that the actor is "flagging" the object. // Flagging is defined in the sense common to many social platforms as reporting content as being // inappropriate for any number of reasons. Flag Activity - // Indicates that the actor is "following" the object. Following is defined in the sense typically used within + // Follow indicates that the actor is "following" the object. Following is defined in the sense typically used within // Social systems in which the actor is interested in any activity performed by or on the object. // The target and origin typically have no defined meaning. Follow Activity - // Indicates that the actor is ignoring the object. The target and origin typically have no defined meaning. + // Ignore indicates that the actor is ignoring the object. The target and origin typically have no defined meaning. Ignore Activity - // A specialization of Offer in which the actor is extending an invitation for the object to the target. + // Invite is a specialization of Offer in which the actor is extending an invitation for the object to the target. Invite Offer - // Indicates that the actor has joined the object. The target and origin typically have no defined meaning. + // Join indicates that the actor has joined the object. The target and origin typically have no defined meaning. Join Activity - // Indicates that the actor has left the object. The target and origin typically have no meaning. + // Leave indicates that the actor has left the object. The target and origin typically have no meaning. Leave Activity - // Indicates that the actor likes, recommends or endorses the object. + // Like indicates that the actor likes, recommends or endorses the object. // The target and origin typically have no defined meaning. Like Activity - // Inherits all properties from Activity. + // Listen inherits all properties from Activity. Listen Activity - // Indicates that the actor has moved object from origin to target. + // Move indicates that the actor has moved object from origin to target. // If the origin or target are not specified, either can be determined by context. Move Activity - // Indicates that the actor is offering the object. + // Offer indicates that the actor is offering the object. // If specified, the target indicates the entity to which the object is being offered. Offer Activity - // Indicates that the actor is rejecting the object. The target and origin typically have no defined meaning. + // Reject indicates that the actor is rejecting the object. The target and origin typically have no defined meaning. Reject Activity - // Indicates that the actor has read the object. + // Read indicates that the actor has read the object. Read Activity - // Indicates that the actor is removing the object. If specified, + // Remove indicates that the actor is removing the object. If specified, // the origin indicates the context from which the object is being removed. Remove Activity - // A specialization of Reject in which the rejection is considered tentative. + // TentativeReject is a specialization of Reject in which the rejection is considered tentative. TentativeReject Reject - // A specialization of Accept indicating that the acceptance is tentative. + // TentativeAccept is a specialization of Accept indicating that the acceptance is tentative. TentativeAccept Accept - // Indicates that the actor is traveling to target from origin. + // Travel indicates that the actor is traveling to target from origin. // Travel is an IntransitiveObject whose actor specifies the direct object. // If the target or origin are not specified, either can be determined by context. Travel IntransitiveActivity - // Indicates that the actor is undoing the object. In most cases, the object will be an Activity describing + // Undo indicates that the actor is undoing the object. In most cases, the object will be an Activity describing // some previously performed action (for instance, a person may have previously "liked" an article but, // for whatever reason, might choose to undo that like at some later point in time). // The target and origin typically have no defined meaning. Undo Activity - // Indicates that the actor has updated the object. Note, however, that this vocabulary does not define a mechanism + // Update indicates that the actor has updated the object. Note, however, that this vocabulary does not define a mechanism // for describing the actual set of modifications made to object. // The target and origin typically have no defined meaning. Update Activity - // Indicates that the actor has viewed the object. + // View indicates that the actor has viewed the object. View Activity ) - // Represents a question being asked. Question objects are an extension of IntransitiveActivity. + // Question represents a question being asked. Question objects are an extension of IntransitiveActivity. // That is, the Question object is an Activity, but the direct object is the question // itself and therefore it would not contain an object property. // Either of the anyOf and oneOf properties may be used to express possible answers,
• src/activitypub/actors.go
  • @@ -1,7 +1,7 @@
    package activitypub + // Actor Types const ( - // Actor Types ApplicationType ActivityVocabularyType = "Application" GroupType ActivityVocabularyType = "Group" OrganizationType ActivityVocabularyType = "Organization"
  • @@ -17,6 +17,7 @@ var validActorTypes = [...]ActivityVocabularyType{
    ServiceType, } + // Endpoints type Endpoints struct { // Upload endpoint URI for this user for binary data. UploadMedia ObjectOrLink `jsonld:"uploadMedia,omitempty"`
  • @@ -70,19 +71,19 @@ type Actor struct {
    } type ( - // Describes a software application. + // Application describes a software application. Application Actor - // Represents a formal or informal collective of Actors. + // Group represents a formal or informal collective of Actors. Group Actor - // Represents an organization. + // Organization represents an organization. Organization Actor - // Represents an individual person. + // Person represents an individual person. Person Actor - // Represents a service of any kind. + // Service represents a service of any kind. Service Actor )