[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pdf-devel
Subject:    [pdf-devel] Patch for stm documentation errors.
From:       "gerel" <gerel () gnu ! org>
Date:       2009-04-19 19:21:29
Message-ID: 49eb7a8b.c6c1f10a.3833.2e56 () mx ! google ! com
[Download RAW message or body]


Hey all, while reading the ref doc I found a few description errors.

BTW, on function descriptions it's unpleasant to find "this is the same
as..." , it's nicer to copy the description thereof.

Patch follows,
##
# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: gerel@gnu.org-20090419191134-eurwefzyg37iqbbj
# target_branch: file:///home/gerel/PROJECTS/libgnupdf/trunk/
# testament_sha1: c4e3c675750c4e614b69df35af941be386bc3828
# timestamp: 2009-04-19 16:11:41 -0300
# base_revision_id: jemarch@termi-20090416221338-b8nyznfgedla5ys9
# 
# Begin patch
=== modified file 'ChangeLog'
--- ChangeLog	2009-04-16 22:13:38 +0000
+++ ChangeLog	2009-04-19 19:11:34 +0000
@@ -1,3 +1,7 @@
+2009-04-19  Gerardo E. Gidoni  <gerel@gnu.org>
+
+	* doc/gnupdf.texi: corrected pdf_stm_write/flush return descriptions.
+
 2009-04-17  Jose E. Marchesi  <jemarch@gnu.org>
 
 	* Time module bugfixes and an initial set of unit tests by Lukasz

=== modified file 'doc/gnupdf.texi'
--- doc/gnupdf.texi	2009-03-03 22:26:28 +0000
+++ doc/gnupdf.texi	2009-04-19 19:11:34 +0000
@@ -4464,13 +4464,13 @@
 A PDF status value:
 @table @code
 @item PDF_OK
-All the requested bytes were successfully read into @var{buf}.
+All the requested bytes were successfully written into @var{stm}.
 @item PDF_EEOF
 A disk full condition occurred.
 @item PDF_EINVOP
 Writting was requested in a read stream.
 @item PDF_ERROR
-An error prevented to read the bytes.
+An error prevented to write the bytes.
 @end table
 @item Usage example
 @example
@@ -4560,8 +4560,17 @@
 flushed bytes. May be @code{0}.
 @end table
 @item Returns
-A PDF status value. The possible values are the same than the exit
-status of @code{pdf_stm_write}.
+A PDF status value:
+@table @code
+@item PDF_OK
+All the requested bytes were successfully written into @var{stm}.
+@item PDF_EEOF
+A disk full condition occurred.
+@item PDF_EINVOP
+Writting was requested in a read stream.
+@item PDF_ERROR
+An error prevented to write the bytes.
+@end table
 @item Usage example
 @example
 XXX

# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWejuGj8AAjXfgAAwUXP//3+t
0YC////6UAUMvUAGtKaD0B4SiTQamp6Q2p+oaT01NMyTGoBo0A0A0HNMTJk0YTBMTTAJgEMEYEYB
KBFIaYg2o9TT2qBoNNAAaaaGgAMpTTJkeoNMQ0AGQGhkNA00AASRBAARoJPTJo0pjINEaeoGg9TQ
KUXLz2tGnWzz2Xle7CyJIUVHK4HUQ5lzrbLhfRLbMgm3YtH0YqdpR4y8ruBO4vKKKHnaQzxN7b24
h3UuKy1jzeCldiNg5MwXchaG1qNOeFyZmq+20iRBCtnaGPKM+NsQe1khEK0GHAMICmTao8umKirp
ZU2p0FcOk0u/LyAfn6oIVXMp8cImWmMDXkOwMBMvVBUFAGJj/5RcGTZPJ9IhUE6X8fLjYQP1oTxo
hKvDSiBNCRkDSB85kAXsPAYrQwuzoQErFBTOECq5SZDrbWQoAmPcMdfO9o6voOFoDmCoxWUiwMnW
08PXqyAoAhYqSswJJqEe5kJyQ2Aagve8hBEjSNhEnSUVmooR3wLhhgmqdGqIpgbQ13qSpIlZgmBU
g38lx0AhSGJOR/hhhk1kL6gNKrFEiMCwUiox9951F1fVVBLwTohIcjG09RosDYZkqMGGwJ4NicMx
sgxMTKA6gWklmEaS3SZWVBwtx1F9gWFD3hIzNRxU8C5CxIEipWsVEBh6wpMS8pMUEHcIWWEp695M
ymUEq62MSkKq5d9NwyExAAt2bLDOLFKyM+FlbFt2FSdOEb1YifwLeJFlmweTF/oxfSM7Nkc+g5Bj
ns8134Qm5Qzwvu541QGQYHGEkooKYp9qEo+SS+/ohIh9D2efxlnQhnl/VfmFe7MdmQ2eUTUx3fO/
qJi07+R0N4dw50KzddMs+gXUcRWho/YcKOhnR19CCVEkNzUj59RadgbgOK+AFxw+a5B2gfkuZwKV
+C8yWA9Ru2o6vjfhD0xXX11sKdbrOB2iiEAbUcywWVFnEBqO1WBlHFqqrmbtXKKKSGRIDvpNAyxc
A8acc+csTWPimUgmFQvwYkWsdjEJB1OxrAdIgb5B9EMcpexDINuUvtWVpHOIcC0HDgVaGQ21XesB
kihBHbQHQMZYUHOUlMwlEvJuBlOIvmTFJ0uC9FZpgS46r4w6DxAbEkyMQc9n1vHBjLtSIQZvS/rS
YX2c4BnZsS9a1BLpDMn5i75nBaxObz9kWwgfbZGGcmAa3yA9qCyC3A7mbXUnv+QE1p1Mts2p1o8e
ytTBxFQVncLl7fQZTOVUsYwGDSLOi9QXZvsIi1909aqJkZ3lZBBvVMJoidgORUPBpKIyZhe5JOdA
DKQ4gRGYU2afxwKTwQipOUWJYI7Ei0krs61iirWwN27cHUEZLGgKfCcyqobJBeblvrHTI4PATFOG
s4xSJJSC8t7oFzKFiRRTr0R/sg/EmGeFNwYFEpjsMw4DrBPA9rGsJPUM3aPucodWLYgYaYTRmyaP
/E0QTXXc+LmHiFH3YF6i62TIhgphmHIKgsYNV45RTrtCwkOh0zKbBINWESckiZ12bF1hIJW5WAPQ
VZEShMghRYA52fFzcx5HyWdSCm64d25qwCHmEAvDXUvhvCzjoBadDUXckU4UJDo7ho/A

###

-gerel



[prev in list] [next in list] [prev in thread] [next in thread]