Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-106666

NOTE FOR DEVELOPERS mistakenly added as method Javadoc

    Details

      Description

      The Service Builder generated classes have a note that warns developers to NOT modify the source code. The note is meant to be read by developers viewing the source code and was therefore written as a Java comment. 

      The note was mistakenly changed to a Javadoc comment and was applied to the next member of the generated class (typically the first method). 

      Example:

      See the generated code here: https://github.com/liferay/liferay-portal/blob/master/portal-kernel/src/com/liferay/announcements/kernel/service/AnnouncementsEntryService.java#L49-L58

      /** NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use {@link AnnouncementsEntryServiceUtil} to access the announcements entry remote service. Add custom service methods to <code>com.liferay.portlet.announcements.service.impl.AnnouncementsEntryServiceImpl</code> and rerun ServiceBuilder to automatically copy the method declarations to this interface.
      */
      public AnnouncementsEntry addEntry( long classNameId, long classPK, String title, String content, String url, String type, Date displayDate, Date expirationDate, int priority, boolean alert) throws PortalException;

      The templates that generate the classes needs to be changed back to having the note as a java comment, not a Javadoc.

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              brian.chan Brian Chan
              Reporter:
              james.hinkey James Hinkey
              Participants of an Issue:
              Recent user:
              Clarissa Velazquez
              Engineering Assignee:
              James Hinkey
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Days since last comment:
                42 weeks, 1 day ago

                  Packages

                  Version Package
                  7.0.0 DXP FP89
                  7.0.X
                  7.1.10 DXP FP17
                  7.1.10.4 SP4
                  7.1.X
                  7.2.10 DXP FP4
                  7.2.X