Skip to content

Commit

Permalink
add doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
leque committed Jul 25, 2022
1 parent 9041f12 commit 7307627
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/backend/loadRawImage.mli
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
(**
A Generic image loader for PDF.
*)

open MyUtil

(**
[make_xobject pdfmain colorspace widdots hgtdots abs_path] creates a PDF XObject Image
for the file located at [abspath] with ColorSpace = [colorspace], Width = [widdots], and Height = [hgtdots],
and then add it to the PDF document [pdfmain].
[colorspace] is can be acquired by {!val:ImageHashTable.find}.
[widdots] and [hgtdots] are the image width and height in dots.
This function raises {!val:ImageHashTable.CannotLoadImage} if the images format is not supported
or the image cannot be loaded due to any other reason.
*)
val make_xobject : Pdf.t -> Pdf.pdfobject -> int -> int -> abs_path -> Pdf.pdfobject

0 comments on commit 7307627

Please sign in to comment.