doc for datamatrix

johnfercher · Jun 23, 2021 · b6e05b7 · b6e05b7
1 parent 95e580f
commit b6e05b7
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -40,7 +40,8 @@ go get -u github.com/johnfercher/maroto
 * [Signature](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.Signature)
 * Image ([From file](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.FileImage) or [Base64](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.Base64Image))
 * [QrCode](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.QrCode)
-* [Barcode](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.Barcode)   
+* [Barcode](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.Barcode) 
+* [DataMatrixCode](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#P#PdfMaroto.DataMatrixCode)  
 
 #### Components To Use Outside a Row
 * [TableList](https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf?tab=doc#PdfMaroto.TableList)

diff --git a/docs/doc.go b/docs/doc.go
@@ -18,6 +18,8 @@ Features and Components
 
 -   Qrcodes
 
+-   DataMatrix codes
+
 -   Signatures
 
 Maroto has only gofpdf dependency. All tests pass on Linux and Mac.

diff --git a/internal/code.go b/internal/code.go
@@ -28,6 +28,7 @@ func NewCode(pdf fpdf.Fpdf, math Math) *code {
 	}
 }
 
+// AddDataMatrix creates a DataMatrix code inside a cell
 func (s *code) AddDataMatrix(code string, cell Cell, prop props.Rect) {
 	key := barcode.RegisterDataMatrix(s.pdf, code)
 

diff --git a/pkg/pdf/pdf.go b/pkg/pdf/pdf.go
@@ -481,6 +481,8 @@ func (s *PdfMaroto) Barcode(code string, prop ...props.Barcode) (err error) {
 
 	return
 }
+
+// DataMatrixCode creates an datamatrix code inside a cell.
 func (s *PdfMaroto) DataMatrixCode(code string, prop ...props.Rect) {
 	rectProp := props.Rect{}
 	if len(prop) > 0 {