Minor documentation updates for fpdfview.h.

Minor documentation updates for fpdfview.h.

This does some minor copy editing and formatting of the documentation in the
fpdfview.h header.

R=tsepez@chromium.org

Committed: https://pdfium.googlesource.com/pdfium/+/19169dae5bf92813b7419793f61dfca8b4fb9124

[dsinclair, 2015-10-20 16:08:49]

dsinclair@chromium.org changed reviewers:
+ thestig@chromium.org, tsepez@chromium.org

[dsinclair, 2015-10-20 16:08:49]

PTAL.

I think it's an improvement, but then I'm biased.

[Tom Sepez, 2015-10-20 16:29:49]

I agree this is an improvement.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h
File public/fpdfview.h (right):

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode61
public/fpdfview.h:61: // FPDFSDK always uses UTF-16LE encoded wide string, each
character uses 2
nit: uses ... wide strings (plural)

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode66
public/fpdfview.h:66: // Windows unicode string, however, special care needs to
be taken if you
nit: as a Windows  (add "a").

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode70
public/fpdfview.h:70: // for a Unicode character, you have to convert between
FPDF_WIDESTRING and
nit: , and you [or change , to a ; ]

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode81
public/fpdfview.h:81: float a; /**< @brief Coefficient a.*/
nit: These comments add no value.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode186
public/fpdfview.h:186: //          enable -   True to enable, False to disable
the policy.
nit: no need to capitalize False.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode254
public/fpdfview.h:254: //          The application should maintain the file
resources until
nit: The application must keep the file resources valid until the PDF document
is closed.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode267
public/fpdfview.h:267: //          TRUE if this call succeeds.
nit: succeeds, false otherwise.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode269
public/fpdfview.h:269: //          If the document is created by
::FPDF_CreateNewDocument,
nit: lose the ::, "was created by"

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode270
public/fpdfview.h:270: //          then this function would always fail.
nit: will always

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode369
public/fpdfview.h:369: #define FPDF_ANNOT 0x01  // Set if annotations are to be
rendered.
nit: (super-nit) can we get these each to fit on a single line by judicious
editing (drop the "Set if"), or perhaps the comment comes first on its own line
with a blank line after the define?  It hurts my eyes.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode615
public/fpdfview.h:615: //          Similar to FPDFBitmap_Create function, bug
allows for more formats
but allows [ :). ]

[Tom Sepez, 2015-10-20 16:31:14]

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h
File public/fpdfview.h (right):

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode79
public/fpdfview.h:79: /** @brief Matrix for transformation. */
Also, can we change these to // - style and drop the doxy annotations?

[dsinclair, 2015-10-20 16:52:29]

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h
File public/fpdfview.h (right):

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode61
public/fpdfview.h:61: // FPDFSDK always uses UTF-16LE encoded wide string, each
character uses 2
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: uses ... wide strings (plural)

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode66
public/fpdfview.h:66: // Windows unicode string, however, special care needs to
be taken if you
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: as a Windows  (add "a").

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode70
public/fpdfview.h:70: // for a Unicode character, you have to convert between
FPDF_WIDESTRING and
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: , and you [or change , to a ; ]

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode79
public/fpdfview.h:79: /** @brief Matrix for transformation. */
On 2015/10/20 16:31:13, Tom Sepez wrote:
> Also, can we change these to // - style and drop the doxy annotations?

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode81
public/fpdfview.h:81: float a; /**< @brief Coefficient a.*/
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: These comments add no value.

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode186
public/fpdfview.h:186: //          enable -   True to enable, False to disable
the policy.
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: no need to capitalize False.  

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode254
public/fpdfview.h:254: //          The application should maintain the file
resources until
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: The application must keep the file resources valid until the PDF document
> is closed.

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode267
public/fpdfview.h:267: //          TRUE if this call succeeds.
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: succeeds, false otherwise.

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode269
public/fpdfview.h:269: //          If the document is created by
::FPDF_CreateNewDocument,
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: lose the ::, "was created by"

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode270
public/fpdfview.h:270: //          then this function would always fail.
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: will always 

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode369
public/fpdfview.h:369: #define FPDF_ANNOT 0x01  // Set if annotations are to be
rendered.
On 2015/10/20 16:29:49, Tom Sepez wrote:
> nit: (super-nit) can we get these each to fit on a single line by judicious
> editing (drop the "Set if"), or perhaps the comment comes first on its own
line
> with a blank line after the define?  It hurts my eyes.

Done.

https://codereview.chromium.org/1411863004/diff/1/public/fpdfview.h#newcode615
public/fpdfview.h:615: //          Similar to FPDFBitmap_Create function, bug
allows for more formats
On 2015/10/20 16:29:49, Tom Sepez wrote:
> but allows [ :). ]

Done.

[Tom Sepez, 2015-10-20 17:10:20]

LGTM, one typo.

https://codereview.chromium.org/1411863004/diff/20001/public/fpdfview.h
File public/fpdfview.h (right):

https://codereview.chromium.org/1411863004/diff/20001/public/fpdfview.h#newco...
public/fpdfview.h:370: // Set if annotations are to be rendered./
nit: trailing /

[dsinclair, 2015-10-20 18:12:55]

https://codereview.chromium.org/1411863004/diff/20001/public/fpdfview.h
File public/fpdfview.h (right):

https://codereview.chromium.org/1411863004/diff/20001/public/fpdfview.h#newco...
public/fpdfview.h:370: // Set if annotations are to be rendered./
On 2015/10/20 17:10:20, Tom Sepez wrote:
> nit: trailing /

Done.

[dsinclair, 2015-10-20 18:13:05]

Committed patchset #3 (id:40001) manually as
19169dae5bf92813b7419793f61dfca8b4fb9124 (presubmit successful).