From 9387c2e705f140aa4c26bc25a259868fb7a473e9 Mon Sep 17 00:00:00 2001
From: Tor Andersson <tor.andersson@artifex.com>
Date: Tue, 25 Oct 2016 14:49:12 +0200
Subject: js: Update docs for annotation functions (WIP).

---
 docs/mutool/run.html | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'docs')

diff --git a/docs/mutool/run.html b/docs/mutool/run.html
index bb726e2c..328e0988 100644
--- a/docs/mutool/run.html
+++ b/docs/mutool/run.html
@@ -781,6 +781,33 @@ Pages consist of a content stream, and a resource dictionary containing all of t
 <dd>Create a PDF object from the Image object.
 </dl>
 
+<h3>
+PDF Annotations (WORK IN PROGRESS!)
+</h3>
+
+<dl>
+<dt>PDFPage#createAnnotation(type)
+<dd>Create a new blank annotation of a given type.
+The type must be one of the annotation subtypes listed in the PDF reference.
+<dt>PDFPage#deleteAnnotation(annot)
+<dd>Delete the annotation from the page.
+</dl>
+
+<dl>
+<dt>PDFAnnotation#getType()
+<dd>Return the annotation subtype.
+<dt>PDFAnnotation#getFlags(), #setFlags(flags)
+<dd>Get/set the annotation flags.
+<dt>PDFAnnotation#getContents(), #setContents(text)
+<dt>PDFAnnotation#getRect(), #setRect(rect)
+<dt>PDFAnnotation#getBorder(), #setBorder(width)
+<dt>PDFAnnotation#getColor(), #setColor(color)
+<dt>PDFAnnotation#getQuadPoints(), #setQuadPoints(quadPoints)
+<dt>PDFAnnotation#getInkList(), #setInkList(inkList)
+<dt>PDFAnnotation#updateAppearance()
+<dd>Update the appearance stream to account for changes in the annotation.
+</dl>
+
 <h2>
 TODO
 </h2>
-- 
cgit v1.2.3