summaryrefslogtreecommitdiff
path: root/htmlbasic.go
diff options
context:
space:
mode:
authorKurt Jung <kurt.w.jung@code.google.com>2014-06-30 07:10:14 -0400
committerKurt Jung <kurt.w.jung@code.google.com>2014-06-30 07:10:14 -0400
commit544558bbfab23c6131b62f17cef4dbf494f4c953 (patch)
tree4fdd70081356ca39df8720f9972bf84cf3993abc /htmlbasic.go
parent875b1c7a15f289f388a0187781c5f2b1f4e9dc90 (diff)
Reference tutorial for writing basic HTML.
Diffstat (limited to 'htmlbasic.go')
-rw-r--r--htmlbasic.go13
1 files changed, 8 insertions, 5 deletions
diff --git a/htmlbasic.go b/htmlbasic.go
index 93e4924..2340c23 100644
--- a/htmlbasic.go
+++ b/htmlbasic.go
@@ -104,6 +104,8 @@ type HTMLBasicType struct {
// HTMLBasicNew returns an instance that facilitates writing basic HTML in the
// specified PDF file.
+//
+// This function is demonstrated in tutorial 6.
func (f *Fpdf) HTMLBasicNew() (html HTMLBasicType) {
html.pdf = f
html.Link.ClrR, html.Link.ClrG, html.Link.ClrB = 0, 0, 128
@@ -112,11 +114,12 @@ func (f *Fpdf) HTMLBasicNew() (html HTMLBasicType) {
}
// Write prints text from the current position using the currently selected
-// font. The text can be encoded with a basic subset of HTML that includes
-// hyperlinks and tags for italic (I), bold (B) and underscore (U) attributes.
-// When the right margin is reached a line break occurs and text continues from
-// the left margin. Upon method exit, the current position is left at the end
-// of the text.
+// font. See HTMLBasicNew() to create a receiver that is associated with the
+// PDF document instance. The text can be encoded with a basic subset of HTML
+// that includes hyperlinks and tags for italic (I), bold (B) and underscore
+// (U) attributes. When the right margin is reached a line break occurs and
+// text continues from the left margin. Upon method exit, the current position
+// is left at the end of the text.
//
// lineHt indicates the line height in the unit of measure specified in New().
func (html *HTMLBasicType) Write(lineHt float64, htmlStr string) {