summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKurt Jung <kurt.w.jung@code.google.com>2013-08-24 16:21:35 -0400
committerKurt Jung <kurt.w.jung@code.google.com>2013-08-24 16:21:35 -0400
commit5591db1df1ec5d5a357755e6f3c40172b9609529 (patch)
treeb995737b531e5a2373872a54b596f6989b46be96
parent2794792c13f56dbb2bbabe2c640b9ee29117709f (diff)
Documentation tweaks
-rw-r--r--def.go13
-rw-r--r--fpdf.go22
2 files changed, 20 insertions, 15 deletions
diff --git a/def.go b/def.go
index 49129c7..60ab58c 100644
--- a/def.go
+++ b/def.go
@@ -20,6 +20,7 @@ import (
"bytes"
)
+// Version of FPDF from which this package is derived
const (
FPDF_VERSION = "1.7"
)
@@ -78,6 +79,18 @@ type intLinkType struct {
y float64
}
+// InitType is used with NewCustom() to customize an Fpdf instance.
+// OrientationStr, UnitStr, SizeStr and FontDirStr correspond to the arguments
+// accepted by New(). If the Wd and Ht fields of Size are each greater than
+// zero, Size will be used to set the default page size rather than SizeStr.
+type InitType struct {
+ OrientationStr string
+ UnitStr string
+ SizeStr string
+ Size SizeType
+ FontDirStr string
+}
+
type Fpdf struct {
page int // current page number
n int // current object number
diff --git a/fpdf.go b/fpdf.go
index d8718a3..1bd2530 100644
--- a/fpdf.go
+++ b/fpdf.go
@@ -173,21 +173,10 @@ func fpdfNew(orientationStr, unitStr, sizeStr, fontDirStr string, size SizeType)
return
}
-// InitType is used with NewCustom() to customize an Fpdf instance.
-// OrientationStr, UnitStr, SizeStr and FontDirStr correspond to the arguments
-// accepted by New(). If the Wd and Ht fields of Size are each greater than
-// zero, Size will be used to set the default page size rather than SizeStr.
-type InitType struct {
- OrientationStr string
- UnitStr string
- SizeStr string
- Size SizeType
- FontDirStr string
-}
-
// NewCustom returns a pointer to a new Fpdf instance. Its methods are
// subsequently called to produce a single PDF document. NewCustom() is an
-// alternative to New() that provides additional customization.
+// alternative to New() that provides additional customization. This function
+// is demonstrated in tutorial 15.
func NewCustom(init *InitType) (f *Fpdf) {
return fpdfNew(init.OrientationStr, init.UnitStr, init.SizeStr, init.FontDirStr, init.Size)
}
@@ -416,7 +405,7 @@ func (f *Fpdf) SetCreator(creatorStr string, isUTF8 bool) {
}
// Defines an alias for the total number of pages. It will be substituted as
-// the document is closed.
+// the document is closed. This method is demonstrated in tutorial 2.
func (f *Fpdf) AliasNbPages(aliasStr string) {
if aliasStr == "" {
aliasStr = "{nb}"
@@ -467,7 +456,8 @@ func (f *Fpdf) Close() {
// Returns the width and height of the specified page in the units established
// in New(). These return values are followed by the unit of measure itself. If
// pageNum is zero or otherwise out of bounds, it returns the default page
-// size, that is, the size of the page that would be added by AddPage().
+// size, that is, the size of the page that would be added by AddPage(). This
+// function is demonstrated in tutorial 15.
func (f *Fpdf) PageSize(pageNum int) (wd, ht float64, unitStr string) {
sz, ok := f.pageSizes[pageNum]
if ok {
@@ -484,6 +474,8 @@ func (f *Fpdf) PageSize(pageNum int) (wd, ht float64, unitStr string) {
// See New() for a description of orientationStr.
//
// size specifies the size of the new page in the units established in New().
+//
+// This function is demonstrated in tutorial 15.
func (f *Fpdf) AddPageFormat(orientationStr string, size SizeType) {
if f.err != nil {
return