Merge pull request #34 from gomutex/comments-update

doc update and moved API funcs of Run to docx

Author: gomutex

README.md

@@ -37,7 +37,7 @@ import (
 
 func main() {
 		// Open an existing DOCX document
-	// docx, err := godocx.OpenDocument("./testdata/test.docx")
+	// document, err := godocx.OpenDocument("./testdata/test.docx")
 
 	// Create New Document
 	document, err := godocx.NewDocument()

dml/dmlct/doc.go

@@ -0,0 +1,4 @@
+// Package dmlct provides complex types related to DrawingML (Drawing Markup Language),
+// which is part of the Office Open XML (OOXML) standard. DrawingML is used to represent
+// graphics and drawings in WordprocessingML, SpreadsheetML, and PresentationML documents.
+package dmlct

dml/dmlst/doc.go

@@ -0,0 +1,4 @@
+// Package dml provides simple types used in DrawingML (Drawing Markup Language),
+// part of the Office Open XML (OOXML) standard for representing graphical elements
+// in documents.
+package dmlst

dml/doc.go

@@ -0,0 +1,4 @@
+// Package dml provides functionality for working with DrawingML (Drawing Markup Language)
+// which is part of the Office Open XML (OOXML) standard. DrawingML is used to represent
+// graphics and drawings in WordprocessingML, SpreadsheetML, and PresentationML documents.
+package dml

docx/body.go

@@ -8,7 +8,7 @@ import (
 
 // This element specifies the contents of the body of the document – the main document editing surface.
 type Body struct {
-	Root     *RootDoc
+	root     *RootDoc
 	XMLName  xml.Name `xml:"http://schemas.openxmlformats.org/wordprocessingml/2006/main body"`
 	Children []DocumentChild
 	SectPr   *ctypes.SectionProp
@@ -23,7 +23,7 @@ type DocumentChild struct {
 // Use this function to initialize a new Body before adding content to it.
 func NewBody(root *RootDoc) *Body {
 	return &Body{
-		Root: root,
+		root: root,
 	}
 }
 
@@ -40,13 +40,13 @@ func (b Body) MarshalXML(e *xml.Encoder, start xml.StartElement) (err error) {
 	if b.Children != nil {
 		for _, child := range b.Children {
 			if child.Para != nil {
-				if err = child.Para.CT.MarshalXML(e, xml.StartElement{}); err != nil {
+				if err = child.Para.ct.MarshalXML(e, xml.StartElement{}); err != nil {
 					return err
 				}
 			}
 
 			if child.Table != nil {
-				if err = child.Table.CT.MarshalXML(e, xml.StartElement{}); err != nil {
+				if err = child.Table.ct.MarshalXML(e, xml.StartElement{}); err != nil {
 					return err
 				}
 			}
@@ -76,14 +76,14 @@ func (body *Body) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err erro
 		case xml.StartElement:
 			switch elem.Name.Local {
 			case "p":
-				para := NewParagraph(body.Root)
-				if err := d.DecodeElement(&para.CT, &elem); err != nil {
+				para := newParagraph(body.root)
+				if err := d.DecodeElement(&para.ct, &elem); err != nil {
 					return err
 				}
 				body.Children = append(body.Children, DocumentChild{Para: para})
 			case "tbl":
-				tbl := NewTable(body.Root)
-				if err := d.DecodeElement(&tbl.CT, &elem); err != nil {
+				tbl := NewTable(body.root)
+				if err := d.DecodeElement(&tbl.ct, &elem); err != nil {
 					return err
 				}
 				body.Children = append(body.Children, DocumentChild{Table: tbl})

docx/core.go

@@ -1,5 +1,3 @@
-// Package oxml provides utilities for working with Office Open XML (OOXML) documents,
-// including functions related to encoding and decoding XML elements.
 package docx
 
 import (

docx/doc.go

@@ -0,0 +1,11 @@
+// Package docx provides a comprehensive set of functions and structures
+// for manipulating DOCX documents. It allows for the creation, modification,
+// and retrieval of document elements such as paragraphs, styles, and images.
+// The package is designed to be accessed through the RootDoc element or
+// instances of inner elements, providing a flexible and intuitive API for
+// working with Office Open XML (OOXML) documents.
+//
+// // The RootDoc structure is initialized from the main godocx package,
+// which provides methods for creating a new document from a default template or
+// opening an existing document.
+package docx

docx/document.go

@@ -110,7 +110,15 @@ func (d *Document) UnmarshalXML(decoder *xml.Decoder, start xml.StartElement) (e
 
 }
 
-// Return newly Paragraph object containing only a page break.
+// AddPageBreak adds a page break to the document by inserting a paragraph containing only a page break.
+//
+// Returns:
+//   - *Paragraph: A pointer to the newly created Paragraph object containing the page break.
+//
+// Example:
+//
+//	document := godocx.NewDocument()
+//	para := document.AddPageBreak()
 func (rd *RootDoc) AddPageBreak() *Paragraph {
 	p := rd.AddEmptyParagraph()
 	p.AddRun().AddBreak(internal.ToPtr(stypes.BreakTypePage))

docx/heading.go

@@ -17,15 +17,15 @@ func (rd *RootDoc) AddHeading(text string, level uint) (*Paragraph, error) {
 		return nil, errors.New("Heading level not supported")
 	}
 
-	p := NewParagraph(rd)
-	p.CT.Property = ctypes.DefaultParaProperty()
+	p := newParagraph(rd)
+	p.ct.Property = ctypes.DefaultParaProperty()
 
 	style := "Title"
 	if level != 0 {
 		style = fmt.Sprintf("Heading%d", level)
 	}
 
-	p.CT.Property.Style = ctypes.NewParagraphStyle(style)
+	p.ct.Property.Style = ctypes.NewParagraphStyle(style)
 
 	bodyElem := DocumentChild{
 		Para: p,

docx/link.go

@@ -6,6 +6,16 @@ import (
 	"github.com/gomutex/godocx/common/constants"
 )
 
+// addLinkRelation adds a hyperlink relationship to the document's relationships collection.
+//
+// Parameters:
+//   - link: A string representing the target URL or location of the hyperlink.
+//
+// Returns:
+//   - string: The ID ("rId" + relation ID) of the added relationship.
+//
+// This function generates a new relationship ID, creates a Relationship object with the specified link as the target,
+// and appends it to the document's relationships collection (DocRels.Relationships). It returns the generated ID of the relationship.
 func (doc *Document) addLinkRelation(link string) string {
 
 	rID := doc.IncRelationID()
@@ -22,6 +32,17 @@ func (doc *Document) addLinkRelation(link string) string {
 	return "rId" + strconv.Itoa(rID)
 }
 
+// addRelation adds a generic relationship to the document's relationships collection.
+//
+// Parameters:
+//   - relType: A string representing the type of relationship (e.g., constants.SourceRelationshipImage).
+//   - fileName: A string representing the target file name or location related to the relationship.
+//
+// Returns:
+//   - string: The ID ("rId" + relation ID) of the added relationship.
+//
+// This function generates a new relationship ID, creates a Relationship object with the specified type and target,
+// and appends it to the document's relationships collection (DocRels.Relationships). It returns the generated ID of the relationship.
 func (doc *Document) addRelation(relType string, fileName string) string {
 	rID := doc.IncRelationID()
 	rel := &Relationship{