I agree. I think Javadoc look and feel is quite standard and people are used to it.
From: <Huo>, Halton <halton....@intel.com<mailto:halton....@intel.com>> Date: Tuesday 16 September 2014 06:03 To: Shiliu Wang <shiliu.w...@intel.com<mailto:shiliu.w...@intel.com>>, "Liu, Shouqun" <shouqun....@intel.com<mailto:shouqun....@intel.com>>, Francesco Balestrieri <francesco.balestri...@intel.com<mailto:francesco.balestri...@intel.com>>, Elliot Smith <elliot.sm...@intel.com<mailto:elliot.sm...@intel.com>> Cc: "<crosswalk-dev@lists. org>" <crosswalk-dev@lists.crosswalk-project.org<mailto:crosswalk-dev@lists.crosswalk-project.org>> Subject: RE: Documentation for Crosswalk Embedding API. I would prefer option 1. From: Crosswalk-dev [mailto:crosswalk-dev-boun...@lists.crosswalk-project.org] On Behalf Of Wang, Shiliu Sent: Tuesday, September 16, 2014 11:00 AM To: Liu, Shouqun; Balestrieri, Francesco; Smith, Elliot Cc: crosswalk-dev@lists.crosswalk-project.org<mailto:crosswalk-dev@lists.crosswalk-project.org> Subject: [Crosswalk-dev] Documentation for Crosswalk Embedding API. Hi, All I want to initial the discussion about the documentation of Crosswalk Embedding API here. Current situation is that Shouqun/Myself will periodly generate API doc manually, and send it to Smith to update our wiki/homepage. https://crosswalk-project.org/apis/embeddingapidocs_v2/reference/org/xwalk/core/package-summary.html Besides, each build will also generate the documentation as well, but it’s not used so far. I’ve uploaded a sample to Github at http://wang16.github.io/Crosswalk-API-Doc/ . The official document is generated by Javadoc + doclava<https://code.google.com/p/doclava/>, the original purpose to use doclava is to hide the unused method by annotation “@hide”, which is only supported by doclava. However, it’s not necessary anymore, all these methods are cleared now. On the other hand, to indicate the API version each API was introduced, “@since” annotation is added in crosswalk source code, but it’s only recognized by standard Javadoc. In conclusion, there are two options ahead. 1) Switch to use standard Javadoc for published API doc, the looking will be changed if so. Is it acceptable to break the consistency here? 2) Still use doclava, but we need to customize it to support @since , which means maintain a fork for it under crosswalk-project. Any suggestion/comments? Thanks, Shiliu. --------------------------------------------------------------------- Intel Finland Oy Registered Address: PL 281, 00181 Helsinki Business Identity Code: 0357606 - 4 Domiciled in Helsinki This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies. _______________________________________________ Crosswalk-dev mailing list Crosswalk-dev@lists.crosswalk-project.org https://lists.crosswalk-project.org/mailman/listinfo/crosswalk-dev
