Consistently put "Experimental API" comments at the top.
Make it easier to see which APIs are marked as experimental.
Change-Id: Id255f2ade55f54522188e7ae01c898817eea6945
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/72091
Reviewed-by: Tom Sepez <tsepez@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
diff --git a/public/fpdf_doc.h b/public/fpdf_doc.h
index 602ccc4..1c8cf3b 100644
--- a/public/fpdf_doc.h
+++ b/public/fpdf_doc.h
@@ -197,8 +197,8 @@
FPDF_EXPORT int FPDF_CALLCONV FPDFDest_GetDestPageIndex(FPDF_DOCUMENT document,
FPDF_DEST dest);
+// Experimental API.
// Get the view (fit type) specified by |dest|.
-// Experimental API. Subject to change.
//
// dest - handle to the destination.
// pNumParams - receives the number of view parameters, which is at most 4.
@@ -330,8 +330,8 @@
int quad_index,
FS_QUADPOINTSF* quad_points);
+// Experimental API.
// Get the file identifer defined in the trailer of |document|.
-// Experimental API. Subject to change.
//
// document - handle to the document.
// id_type - the file identifier type to retrieve.
diff --git a/public/fpdf_structtree.h b/public/fpdf_structtree.h
index 5e1f22e..0bd56ee 100644
--- a/public/fpdf_structtree.h
+++ b/public/fpdf_structtree.h
@@ -75,8 +75,9 @@
void* buffer,
unsigned long buflen);
+// Experimental API.
// Function: FPDF_StructElement_GetID
-// Get the ID for a given element. Experimental API.
+// Get the ID for a given element.
// Parameters:
// struct_element - Handle to the struct element.
// buffer - A buffer for output the ID string. May be NULL.
@@ -95,9 +96,9 @@
void* buffer,
unsigned long buflen);
+// Experimental API.
// Function: FPDF_StructElement_GetLang
// Get the case-insensitive IETF BCP 47 language code for an element.
-// Experimental API.
// Parameters:
// struct_element - Handle to the struct element.
// buffer - A buffer for output the lang string. May be NULL.
@@ -116,9 +117,9 @@
void* buffer,
unsigned long buflen);
+// Experimental API.
// Function: FPDF_StructElement_GetStringAttribute
// Get a struct element attribute of type "name" or "string".
-// Experimental API.
// Parameters:
// struct_element - Handle to the struct element.
// attr_name - The name of the attribute to retrieve.
diff --git a/public/fpdfview.h b/public/fpdfview.h
index 94bf776..47cc97c 100644
--- a/public/fpdfview.h
+++ b/public/fpdfview.h
@@ -297,9 +297,10 @@
const wchar_t* text,
size_t text_length);
+// Experimental API.
// Function: FPDF_SetTypefaceAccessibleFunc
// Set the function pointer that makes GDI fonts available in sandboxed
-// environments. Experimental API.
+// environments.
// Parameters:
// func - A function pointer. See description above.
// Return value:
@@ -307,9 +308,9 @@
FPDF_EXPORT void FPDF_CALLCONV
FPDF_SetTypefaceAccessibleFunc(PDFiumEnsureTypefaceCharactersAccessible func);
+// Experimental API.
// Function: FPDF_SetPrintTextWithGDI
// Set whether to use GDI to draw fonts when printing on Windows.
-// Experimental API.
// Parameters:
// use_gdi - Set to true to enable printing text with GDI.
// Return value:
@@ -317,9 +318,9 @@
FPDF_EXPORT void FPDF_CALLCONV FPDF_SetPrintTextWithGDI(FPDF_BOOL use_gdi);
#endif // PDFIUM_PRINT_TEXT_WITH_GDI
+// Experimental API.
// Function: FPDF_SetPrintMode
// Set printing mode when printing on Windows.
-// Experimental API.
// Parameters:
// mode - FPDF_PRINTMODE_EMF to output EMF (default)
// FPDF_PRINTMODE_TEXTONLY to output text only (for charstream
@@ -385,9 +386,9 @@
FPDF_EXPORT FPDF_DOCUMENT FPDF_CALLCONV
FPDF_LoadMemDocument(const void* data_buf, int size, FPDF_BYTESTRING password);
+// Experimental API.
// Function: FPDF_LoadMemDocument64
// Open and load a PDF document from memory.
-// Experimental API.
// Parameters:
// data_buf - Pointer to a buffer containing the PDF document.
// size - Number of bytes in the PDF document.
@@ -590,9 +591,9 @@
// function is not defined.
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_GetLastError();
+// Experimental API.
// Function: FPDF_DocumentHasValidCrossReferenceTable
// Whether the document's cross reference table is valid or not.
-// Experimental API.
// Parameters:
// document - Handle to a document. Returned by FPDF_LoadDocument.
// Return value:
@@ -1193,9 +1194,9 @@
FPDF_EXPORT FPDF_PAGERANGE FPDF_CALLCONV
FPDF_VIEWERREF_GetPrintPageRange(FPDF_DOCUMENT document);
+// Experimental API.
// Function: FPDF_VIEWERREF_GetPrintPageRangeCount
// Returns the number of elements in a FPDF_PAGERANGE.
-// Experimental API.
// Parameters:
// pagerange - Handle to the page range.
// Return value:
@@ -1203,9 +1204,9 @@
FPDF_EXPORT size_t FPDF_CALLCONV
FPDF_VIEWERREF_GetPrintPageRangeCount(FPDF_PAGERANGE pagerange);
+// Experimental API.
// Function: FPDF_VIEWERREF_GetPrintPageRangeElement
// Returns an element from a FPDF_PAGERANGE.
-// Experimental API.
// Parameters:
// pagerange - Handle to the page range.
// index - Index of the element.
