[Podofo-users] tidying up PdfString documentation around deactivated lines before/affecting ToUnicode()

[Matthew Brincke]

Hi all,

I have attached a patch as per the subject to this e-mail.

Please review it and if accepted, please apply it (separately)
to the public repository, otherwise please tell me why not.

Best regards, mabri
Index: src/base/PdfString.cpp
===================================================================
--- src/base/PdfString.cpp	(revision 1687)
+++ src/base/PdfString.cpp	(working copy)
@@ -620,7 +620,7 @@
 
 #endif // _WIN32
 
-/*
+#ifdef PODOFO_PUBLIC_STRING_HEX_CODEC // never set, Decode even TODO: REMOVE :(
 PdfString PdfString::HexEncode() const
 {
     if( this->IsHex() )
@@ -674,8 +674,8 @@
 
         return str;
     }
-} 
-*/
+}
+#endif // PODOFO_PUBLIC_STRING_HEX_CODEC 
 
 PdfString PdfString::ToUnicode() const
 {
Index: src/base/PdfString.h
===================================================================
--- src/base/PdfString.h	(revision 1687)
+++ src/base/PdfString.h	(working copy)
@@ -331,29 +331,31 @@
      */
     bool operator!=(const PdfString& rhs) const { return !operator==(rhs); }
 
-    /** Converts this string to a hex encoded string.
+#ifdef PODOFO_PUBLIC_STRING_HEX_CODEC // never set, impl. still TODO: REMOVE :(
+    /** Converts this string to a hex-encoded string.
      *  
      *  If IsHex returns true, a copy of this string is returned
-     *  otherwise the strings data is hex encoded and returned.
+     *  otherwise the string's data is hex-encoded and returned.
      *
-     *  \returns a hex encoded version of this string or this string
-     *           if it is already hex ecoded.
+     *  \returns a hex-encoded version of this string, or this string if it is
+     *           already hex-encoded.
      *
      *  \see IsHex
      */
-    //PdfString HexEncode() const; 
+    PdfString HexEncode() const; 
 
-    /** Converts this string to a ascii string (not hex encoded)
+    /** Converts this string to an ASCII string (not hex-encoded)
      *  
-     *  If IsHex returns false, a copy of this string is returned
-     *  otherwise the strings data is hex decoded and returned.
+     *  If IsHex returns false, a copy of this string is returned,
+     *  otherwise the string's data is hex-decoded and returned.
      *
-     *  \returns a plain version of this string which is not hex encoded
-     *           or this string if it is already a plain not hex encoded string.
+     *  \returns a plain version, which is not hex-encoded, of this string, or
+     *           this string if it is already a plain not hex-encoded string.
      *
      *  \see IsHex
      */
-    //PdfString HexDecode() const; 
+    PdfString HexDecode() const; 
+#endif
 
     /** Converts this string to a unicode string
      *  

------------------------------------------------------------------------------

_______________________________________________
Podofo-users mailing list
Podofo-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/podofo-users