Hello all,
I haven't found any public API documentation for the classes
PdfArray, PdfDictionary and PdfImmediateWriter in the online
documentation. I hope these classes are in the public API of
PoDoFo (at least I haven't found anything to the contrary,
not even in the extensive doc comment on the constructor of
PdfImmediateWriter) and so should be documented. I have
attached my proposed patches for this. Please kindly review
them and please tell me what to fix about them or if you
accept them as-is.
Best regards, mabri
Complete the public class list in API documentation with 3 classes
Move a typedef in PdfArray.h before the doc comment so that it is
for the public class PdfArray, not the typedef. Add doc comments
for PdfDictonary and PdfImmediateWriter to add them to the list too.
diff -urp a/src/base/PdfArray.h b/src/base/PdfArray.h
--- a/src/base/PdfArray.h 2015-07-21 19:09:00.000000000 +0200
+++ b/src/base/PdfArray.h 2015-07-21 21:49:54.624022205 +0200
@@ -47,6 +47,8 @@
namespace PoDoFo {
+typedef std::vector<PdfObject> PdfArrayBaseClass;
+
/** This class represents a PdfArray
* Use it for all arrays that are written to a PDF file.
*
@@ -54,8 +56,6 @@ namespace PoDoFo {
*
* \see PdfVariant
*/
-typedef std::vector<PdfObject> PdfArrayBaseClass;
-
class PODOFO_API PdfArray : private PdfArrayBaseClass, public PdfDataType {
public:
typedef PdfArrayBaseClass::iterator iterator;
diff -urp a/src/base/PdfDictionary.h b/src/base/PdfDictionary.h
--- a/src/base/PdfDictionary.h 2015-07-21 19:09:00.000000000 +0200
+++ b/src/base/PdfDictionary.h 2015-08-03 21:40:22.256572456 +0200
@@ -83,6 +83,9 @@ typedef TKeyMap::const_iterator
class PdfOutputDevice;
+/** The PDF dictionary data type of PoDoFo (inherits from PdfDataType,
+ the base class for such representations)
+*/
class PODOFO_API PdfDictionary : public PdfDataType {
public:
/** Create a new, empty dictionary
diff -urp a/src/base/PdfImmediateWriter.h b/src/base/PdfImmediateWriter.h
--- a/src/base/PdfImmediateWriter.h 2015-07-21 19:09:00.000000000 +0200
+++ b/src/base/PdfImmediateWriter.h 2015-08-03 23:56:39.303216137 +0200
@@ -44,6 +44,9 @@ class PdfEncrypt;
class PdfOutputDevice;
class PdfXRef;
+/** A kind of PdfWriter that writes objects with streams immediately to
+ a PdfOutputDevice
+*/
class PODOFO_API PdfImmediateWriter : private PdfWriter,
private PdfVecObjects::Observer,
private PdfVecObjects::StreamFactory {
------------------------------------------------------------------------------
_______________________________________________
Podofo-users mailing list
Podofo-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/podofo-users
