Skip to content

Commit

Permalink
Better method doc.
Browse files Browse the repository at this point in the history
Signed-off-by: Jeff Ortel <[email protected]>
  • Loading branch information
jortel committed Sep 19, 2024
1 parent 13993d8 commit 079e102
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions binding/application.go
Original file line number Diff line number Diff line change
Expand Up @@ -312,14 +312,20 @@ type Analysis struct {
appId uint
}

// Create an analysis report.
// Create an analysis report using the manifest at the specified path.
// The manifest contains 3 sections containing documents delimited by separators.
// The manifest must contain ALL delimiters even when sections are empty.
// Note: `^]` = `\x1D` = GS (group separator character).
// Section separators:
// ^]BEGIN-MAIN^]
// ^]END-MAIN^]
// ^]BEGIN-ISSUES^]
// ^]END-ISSUES^]
// ^]BEGIN-DEPS^]
// ^]END-DEPS^]
// The encoding must be:
// - application/json
// - application/x-yaml
// The `issues` is the path to a file containing api.Issue(s)
// as individual documents.
// The `deps` is the path to a file containing api.TechDependency(s)
// as individual documents.
func (h *Analysis) Create(manifest, encoding string) (err error) {
switch encoding {
case "":
Expand Down

0 comments on commit 079e102

Please sign in to comment.