commit 25df6e84ce156f28ff7df0222e2a35b9fb683e2d
author Lei Zhang <thestig@chromium.org> Wed Nov 15 04:10:41 2023 +0000
committer Pdfium LUCI CQ <pdfium-scoped@luci-project-accounts.iam.gserviceaccount.com> Wed Nov 15 04:10:41 2023 +0000
tree cb0a37e198d757c5ad0d4fd11557fcf0f374782d
parent 8b1177f2d4254d522f2258bebf6b5ea98a84c129

Mention "document outline" in public/fpdf_doc.h

In the PDF spec, document outline and bookmarks are synonyms. Mention
document outline in the public API comments, to make it more
discoverable.

Change-Id: I5ce679ef0e8da00a1d9ecc5f1cb7161cd4b383b6
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/113593
Reviewed-by: Ben Wagner <bungeman@google.com>
Commit-Queue: Lei Zhang <thestig@chromium.org>

public/fpdf_doc.h

diff --git a/public/fpdf_doc.h b/public/fpdf_doc.h
index b073f4d..2dc22d9 100644
--- a/public/fpdf_doc.h
+++ b/public/fpdf_doc.h
@@ -53,6 +53,8 @@
 //
 // Returns a handle to the first child of |bookmark| or the first top-level
 // bookmark item. NULL if no child or top-level bookmark found.
+// Note that another name for the bookmarks is the document outline, as
+// described in ISO 32000-1:2008, section 12.3.3.
 FPDF_EXPORT FPDF_BOOKMARK FPDF_CALLCONV
 FPDFBookmark_GetFirstChild(FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark);