pdf-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [pdf-devel] Task #7792: Design of the Error Module


From: jemarch
Subject: Re: [pdf-devel] Task #7792: Design of the Error Module
Date: Fri, 22 Feb 2008 17:22:45 +0100
User-agent: Wanderlust/2.14.0 (Africa) SEMI/1.14.6 (Maruoka) FLIM/1.14.8 (Shijō) APEL/10.6 Emacs/23.0.60 (powerpc-unknown-linux-gnu) MULE/6.0 (HANACHIRUSATO)

Just a few comments.

   +The Error module will provide

It is much better to speak in present, like "The Error module
provides". The same applies to the architecture pages.

   address@hidden Status types
   address@hidden Status types
   +
   address@hidden {Data Type} pdf_status_t
   +A status variable.
   address@hidden deftp

I would also comment in the data type description that pdf_status_t
variables are returned by many library functions in order to
communicate the status of the performed operation.

   +For each layer there is a macro procedure defined. The file name and
   +the line number at which the error ocurred is printed to stderr
   +followed by @var{message}.
   +
   address@hidden PDF_DEBUG_BASE (message, ...)
   address@hidden defmac
   address@hidden PDF_DEBUG_OBJECT (message, ...)
   address@hidden defmac
   address@hidden PDF_DEBUG_DOCUMENT (message, ...)
   address@hidden defmac
   address@hidden PDF_DEBUG_PAGE (message, ...)
   address@hidden defmac

Would be good to document the output format used by these macros in
the reference manual. It is useful if users want to automatically
process the output.

If you agree with those suggestions please fix it, commit the patch
and ACK.

Thanks :)





reply via email to

[Prev in Thread] Current Thread [Next in Thread]