aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdnan Maolood <[email protected]>2021-02-23 09:18:34 -0500
committerAdnan Maolood <[email protected]>2021-02-23 09:18:34 -0500
commit964c17b99f434899363c8514b3dfb9509e6a7945 (patch)
tree211b6dabf8ac5aebf39dc9eede9ccefe67877ed0
parentcertificate.Store: Mention GetCertificate usage (diff)
downloadgo-gemini-964c17b99f434899363c8514b3dfb9509e6a7945.tar.xz
go-gemini-964c17b99f434899363c8514b3dfb9509e6a7945.zip
text: Update documentation
-rw-r--r--text.go19
1 files changed, 10 insertions, 9 deletions
diff --git a/text.go b/text.go
index 6263d93..fe37df6 100644
--- a/text.go
+++ b/text.go
@@ -9,38 +9,39 @@ import (
// Line represents a line of a Gemini text response.
type Line interface {
+ // String formats the line for use in a Gemini text response.
String() string
line() // private function to prevent other packages from implementing Line
}
-// A link line.
+// LineLink is a link line.
type LineLink struct {
URL string
Name string
}
-// A preformatting toggle line.
+// LinePreformattingToggle is a preformatting toggle line.
type LinePreformattingToggle string
-// A preformatted text line.
+// LinePreformattedText is a preformatted text line.
type LinePreformattedText string
-// A first-level heading line.
+// LineHeading1 is a first-level heading line.
type LineHeading1 string
-// A second-level heading line.
+// LineHeading2 is a second-level heading line.
type LineHeading2 string
-// A third-level heading line.
+// LineHeading3 is a third-level heading line.
type LineHeading3 string
-// An unordered list item line.
+// LineListItem is an unordered list item line.
type LineListItem string
-// A quote line.
+// LineQuote is a quote line.
type LineQuote string
-// A text line.
+// LineText is a text line.
type LineText string
func (l LineLink) String() string {