[PPAPI] Documentation fixes.

[PPAPI] Documentation fixes.

* I added a closing </code> tag in r191189, but it seems to be more consistent
to forgo <code> tags for enums, so I've removed it.

* I've also added @code/@endcode around a snippet of code that was flattened
otherwise.

BUG=none
R=dmichael@chromium.org

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=193162

[binji, 2013-03-28 21:40:07]

Sorry all the reviews, trying to help clean up the generated docs. :)

[dmichael (off chromium), 2013-03-28 21:56:50]

https://codereview.chromium.org/13238002/diff/1/ppapi/api/ppb_message_loop.idl
File ppapi/api/ppb_message_loop.idl (right):

https://codereview.chromium.org/13238002/diff/1/ppapi/api/ppb_message_loop.id...
ppapi/api/ppb_message_loop.idl:40: *      @code
Is there any reason to not just always use <code> </code>?

[binji, 2013-03-28 22:02:24]

https://codereview.chromium.org/13238002/diff/1/ppapi/api/ppb_message_loop.idl
File ppapi/api/ppb_message_loop.idl (right):

https://codereview.chromium.org/13238002/diff/1/ppapi/api/ppb_message_loop.id...
ppapi/api/ppb_message_loop.idl:40: *      @code
On 2013/03/28 21:56:50, dmichael wrote:
> Is there any reason to not just always use <code> </code>?

I haven't used doxygen much, but it seems like <code></code> does this: <CODE>
Starts a piece of text displayed in a typewriter font.
(see http://www.stack.nl/~dimitri/doxygen/manual/htmlcmds.html)

Whereas @code (or /code) does this:
Starts a block of code. A code block is treated differently from ordinary text.
It is interpreted as source code. The names of classes and members and other
documented entities are automatically replaced by links to the documentation...
(see http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdcode)

[dmichael (off chromium), 2013-03-28 22:14:22]

On 2013/03/28 22:02:24, binji wrote:
> https://codereview.chromium.org/13238002/diff/1/ppapi/api/ppb_message_loop.idl
> File ppapi/api/ppb_message_loop.idl (right):
> 
>
https://codereview.chromium.org/13238002/diff/1/ppapi/api/ppb_message_loop.id...
> ppapi/api/ppb_message_loop.idl:40: *      @code
> On 2013/03/28 21:56:50, dmichael wrote:
> > Is there any reason to not just always use <code> </code>?
> 
> I haven't used doxygen much, but it seems like <code></code> does this: <CODE>
> Starts a piece of text displayed in a typewriter font.
> (see http://www.stack.nl/%7Edimitri/doxygen/manual/htmlcmds.html)
> 
> Whereas @code (or /code) does this:
> Starts a block of code. A code block is treated differently from ordinary
text.
> It is interpreted as source code. The names of classes and members and other
> documented entities are automatically replaced by links to the
documentation...
> (see http://www.stack.nl/%7Edimitri/doxygen/manual/commands.html#cmdcode)
Gah. Okay, thanks for explaining!

FWIW, I ran:
grep "\s*\*\s*<code>$" ppapi/c/*
And got a few hits where I guess we should be using @code...

lgtm

[binji, 2013-03-28 22:38:15]

As long as I'm here, I'll fix the other spots too. It looks a lot better,
compare:

https://developers.google.com/native-client/dev/pepperc/struct_p_p_b___graphi...

to

https://developers.google.com/native-client/dev/pepperc/struct_p_p___array_ou...

[dmichael (off chromium), 2013-03-28 22:41:06]

lgtm, only moreso. Thanks.

[binji, 2013-04-09 18:40:25]

Committed patchset #5 manually as r193162.