Hi all,
I don't like to really break the doc comment, maybe someone wants
to re-enable it ... I therefore resubmit my original idea without
any TODO, attached to this e-mail.
Best regards, mabri
----- Original Message -----
From: zyx <z...@litepdf.cz>
To: podofo-users@lists.sourceforge.net
Sent: 7:19 Thursday, 5 November 2015
Subject: Re: [Podofo-users] tidying up PdfString documentation around
deactivated lines before/affecting ToUnicode()
On Wed, 2015-11-04 at 23:54 +0000, Matthew Brincke wrote:
> So could you please accept this documentation patch,
> or otherwise tell me why you don't accept it as such one?
Hi,
my concern was about added TODO-s (
`cat PdfString-tidy-up-docs-around-deactivated.diff | grep TODO`
) I wouldn't accept it personally. I'm completely fine with fixing the
documentation and the typos in there.
What about, instead of #if 0, simply break the documentation comment?
Aka instead of starting it with
/**
start it with
/* *
thus the doxygen will skip it.
Bye,
zyx
--
http://www.litePDF.cz i...@litepdf.cz
------------------------------------------------------------------------------
_______________________________________________
Podofo-users mailing list
Podofo-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/podofo-usersIndex: src/base/PdfString.cpp
===================================================================
--- src/base/PdfString.cpp (revision 1691)
+++ src/base/PdfString.cpp (working copy)
@@ -620,7 +620,7 @@
#endif // _WIN32
-/*
+#ifdef PODOFO_PUBLIC_STRING_HEX_CODEC // never set, Decode even says 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. even says 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
