summaryrefslogtreecommitdiff
path: root/pdf/mupdf.h
diff options
context:
space:
mode:
authorSebastian Rasmussen <sebras@gmail.com>2012-02-12 16:39:06 +0100
committerRobin Watts <robin@ghostscript.com>2012-02-26 19:35:30 +0000
commitca578b08dc1243dc6cbb3235272d52d9e2336925 (patch)
tree504aef8a9a8c3c0e1561373d5c2057957d776944 /pdf/mupdf.h
parent4420da5546c89849f43016c946525141013610e9 (diff)
downloadmupdf-ca578b08dc1243dc6cbb3235272d52d9e2336925.tar.xz
Continued documentation improvements.
More changes still to come.
Diffstat (limited to 'pdf/mupdf.h')
-rw-r--r--pdf/mupdf.h39
1 files changed, 24 insertions, 15 deletions
diff --git a/pdf/mupdf.h b/pdf/mupdf.h
index f35d4d59..93682083 100644
--- a/pdf/mupdf.h
+++ b/pdf/mupdf.h
@@ -220,15 +220,17 @@ fz_stream *pdf_open_image_decomp_stream(fz_context *ctx, fz_buffer *, pdf_image_
/*
pdf_open_document: Open a PDF document.
- Open a PDF document by reading its cross reference table, so MuPDF
- can locate PDF objects inside the file. Upon an broken cross
- reference table or other parse errors MuPDF will restart parsing
- the file from the beginning to try to rebuild a (hopefully correct)
- cross reference table to allow further processing of the file.
-
- The returned pdf_document should be used when calling most other
- PDF functions. Note that it wraps the context, so those functions
- implicitly get access to the global state in context.
+ Open a PDF document by reading its cross reference table, so
+ MuPDF can locate PDF objects inside the file. Upon an broken
+ cross reference table or other parse errors MuPDF will restart
+ parsing the file from the beginning to try to rebuild a
+ (hopefully correct) cross reference table to allow further
+ processing of the file.
+
+ The returned pdf_document should be used when calling most
+ other PDF functions. Note that it wraps the context, so those
+ functions implicitly get access to the global state in
+ context.
filename: a path to a file as it would be given to open(2).
*/
@@ -237,18 +239,21 @@ pdf_document *pdf_open_document(fz_context *ctx, const char *filename);
/*
pdf_open_document_with_stream: Opens a PDF document.
- Same as pdf_open_document, but takes a stream instead of a filename
- to locate the PDF document to open. Increments the reference count
- of the stream. See fz_open_file, fz_open_file_w or fz_open_fd for
- opening a stream, and fz_close for closing an open stream.
+ Same as pdf_open_document, but takes a stream instead of a
+ filename to locate the PDF document to open. Increments the
+ reference count of the stream. See fz_open_file,
+ fz_open_file_w or fz_open_fd for opening a stream, and
+ fz_close for closing an open stream.
*/
pdf_document *pdf_open_document_with_stream(fz_stream *file);
/*
pdf_close_document: Closes and frees an opened PDF document.
- The resource store in the context associated with pdf_document is
- emptied.
+ The resource store in the context associated with pdf_document
+ is emptied.
+
+ Does not throw exceptions.
*/
void pdf_close_document(pdf_document *doc);
@@ -618,11 +623,15 @@ fz_link *pdf_load_links(pdf_document *doc, pdf_page *page);
into account. The page size is taken to be the crop box if it
exists (visible area after cropping), otherwise the media box will
be used (possibly including printing marks).
+
+ Does not throw exceptions.
*/
fz_rect pdf_bound_page(pdf_document *doc, pdf_page *page);
/*
pdf_free_page: Frees a page and its resources.
+
+ Does not throw exceptions.
*/
void pdf_free_page(pdf_document *doc, pdf_page *page);