Uploaded image for project: 'PUBLIC - Liferay Documentation'
  1. PUBLIC - Liferay Documentation
  2. LRDOCS-8120

Javadoc: Don't tell API consumers to use the LocalServiceUtil

    Details

    • Type: Task
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Fix Version/s: master
    • Component/s: Core Infrastructure
    • Labels:
      None

      Description

      The SB-generated Javadoc for all*LocalService classes is wrong.

      https://github.com/liferay/liferay-portal/blob/7.3.2-ga3/modules/apps/journal/journal-api/src/main/java/com/liferay/journal/service/JournalArticleLocalService.java#L81-L85
       
      Consider particularly

      Always use {@link JournalArticleLocalServiceUtil} to access the journal article local service.

       
      At least this template should be updated:
      https://github.com/liferay/liferay-portal/blob/7.3.2-ga3/modules/util/portal-tools-service-builder/src/main/resources/com/liferay/portal/tools/service/builder/dependencies/service.ftl#L134-L138
       
      Originally discovered while investigating a community question regarding this:
      https://liferay-community.slack.com/archives/C5XE4BH3Q/p1595474308034600

        Attachments

          Activity

            People

            Assignee:
            russell.bohl Russell Bohl
            Reporter:
            russell.bohl Russell Bohl
            Participants of an Issue:
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support

                  Packages

                  Version Package
                  master