Brian, Thanks a lot for you review. I have modified it based on your advices and attached for review again. Besides that, I also reorder the SEE ALSO section first by manpage section number and then alphabetically.
Brian Cameron wrote: > > Jerry: > >> Attached is the manpage modified based on Brian's valuable inputs. >> Please review again. > > Overall looks good, some comments: > > > libpisock, libpisync - C interface for communicating with a > > PalmOS device > > Now that this is talking about two libraries, probably should say > "C interfaces" rather than the singular "interface". Done. > > > libpisock and libpisync are two core pilot-link libraries > > I'd add a period to the end of the sentence. Done. > > > access to those functions. gpilotd-control-applet is one > > This should be gpilotd-control-applet(1). In other words add the > (1). This should be done using <citerefentry><refentrytitle> > format used in the "SEE ALSO" section not just by coding "(1)" > in the manpage. > Done. > You should remove libpisync(3) from the "SEE ALSO" section. You > do not refer to manpages that are documented in the same page. > Since this is now a shadow page for both libpisock and libpisync, > this doesn't need to be listed here. Removed. > > Are there no API docs online for these interfaces? I'd add links > to any API documentation in the SEE ALSO section. Yes. I added the link http://doxygen.pilot-link.org to the SEE ALSO section. Thanks, Jerry -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://mail.opensolaris.org/pipermail/jds-review/attachments/20080804/05e5f9a6/attachment.html>
