bridge/core: document import/export events

Michael Muré created 6 years ago

Change summary

bridge/core/export.go | 11 +++++++++++
bridge/core/import.go | 14 +++++++++++++-
2 files changed, 24 insertions(+), 1 deletion(-)

Detailed changes

bridge/core/export.go

@@ -10,13 +10,24 @@ type ExportEvent int
 
 const (
 	_ ExportEvent = iota
+
+	// Bug has been exported on the remote tracker
 	ExportEventBug
+	// Comment has been exported on the remote tracker
 	ExportEventComment
+	// Comment has been edited on the remote tracker
 	ExportEventCommentEdition
+	// Bug's status has been changed on on the remote tracker
 	ExportEventStatusChange
+	// Bug's title has been changed on the remote tracker
 	ExportEventTitleEdition
+	// Bug's labels have been changed on the remote tracker
 	ExportEventLabelChange
+
+	// Nothing changed on the bug
 	ExportEventNothing
+
+	// Error happened during export
 	ExportEventError
 )
 

bridge/core/import.go

@@ -10,14 +10,26 @@ type ImportEvent int
 
 const (
 	_ ImportEvent = iota
+
+	// Bug has been created
 	ImportEventBug
+	// Comment has been created
 	ImportEventComment
+	// Comment has been edited
 	ImportEventCommentEdition
+	// Bug's status has changed
 	ImportEventStatusChange
+	// Bug's title has changed
 	ImportEventTitleEdition
+	// Bug's labels changed
 	ImportEventLabelChange
-	ImportEventIdentity
+	// Nothing happened on a Bug
 	ImportEventNothing
+
+	// Identity has been created
+	ImportEventIdentity
+
+	// Error happened during import
 	ImportEventError
 )