掲示板

It's possible to generate a description for Mobile SDK generated classes ?

thumbnail
8年前 に Denis Signoretto によって更新されました。

It's possible to generate a description for Mobile SDK generated classes ?

Expert 投稿: 375 参加年月日: 09/04/21 最新の投稿
Hi,

I'd like to know if exist a way to add a description for mobile SDK generated services and methods.
If not, I'm thinking if it make sense create a specific JSONWS annotation (or read jsonws javadoc comment) to include a description in generated JSONWS services to include in generated API (e.g. javadoc for Android).

In this way Mobile developers can find a "standard way" to know how to use some API.

Bye,
Denis.
thumbnail
8年前 に Bruno Farache によって更新されました。

RE: It's possible to generate a description for Mobile SDK generated classe

Liferay Master 投稿: 603 参加年月日: 07/05/14 最新の投稿
Hey Denis,

That's a good idea, I also thought about it. Unfortunately the Discovery service we use (http://localhost:8080/api/jsonws?discover) to generate classes doesn't contain the description of the service.
thumbnail
8年前 に Daniele Baggio によって更新されました。

RE: It's possible to generate a description for Mobile SDK generated classe

Expert 投稿: 336 参加年月日: 08/12/05 最新の投稿
Yes it's just possible to see javadoc from the API of a custom plugin.
I am fixing the /api/jsonws documentation page in these days about this issue.

You have to run
ant format-javadoc
before to generate some xml files necessary.

Then, with an hook plugin and some fix to the jsp pages you can see javadoc comments.

For the hook see the code here:
https://github.com/baxtheman/mqtt-liferay-plugins/tree/master/base-services-portlet/docroot/custom_jsps/html/portal/api/jsonws

See the results:


Bruno, i think it's necessary to open an issue on jira to fix these pages.
In LF7 there are some improvements? or the api/jsonws pages are the ond ones?

bye,
thumbnail
8年前 に Bruno Farache によって更新されました。

RE: It's possible to generate a description for Mobile SDK generated classe

Liferay Master 投稿: 603 参加年月日: 07/05/14 最新の投稿
Hi Daniele,

The discovery service (used to generated code for the SDK) has changed a lot on 7.0 and it does include javadocs by default.