Cleaned up Javadoc around GitLab endpoints.

Author: gmessner

src/main/java/org/gitlab4j/api/EventsApi.java

@@ -21,7 +21,7 @@ public EventsApi(GitLabApi gitLabApi) {
     /**
      * Get a list of events for the authenticated user.
      *
-     * GET /events
+     * <pre><code>GitLab Endpoint: GET /events</code></pre>
      *
      * @param action include only events of a particular action type, optional
      * @param targetType include only events of a particular target type, optional
@@ -39,7 +39,7 @@ public List<Event> getAuthenticatedUserEvents(ActionType action, TargetType targ
     /**
      * Get a list of events for the authenticated user and in the specified page range.
      *
-     * GET /events
+     * <pre><code>GitLab Endpoint: GET /events</code></pre>
      *
      * @param action include only events of a particular action type, optional
      * @param targetType include only events of a particular target type, optional
@@ -70,7 +70,7 @@ public List<Event> getAuthenticatedUserEvents(ActionType action, TargetType targ
     /**
      * Get a list of events for the authenticated user and in the specified page range.
      *
-     * GET /events
+     * <pre><code>GitLab Endpoint: GET /events</code></pre>
      *
      * @param action include only events of a particular action type, optional
      * @param targetType include only events of a particular target type, optional
@@ -97,7 +97,7 @@ public Pager<Event> getAuthenticatedUserEvents(ActionType action, TargetType tar
     /**
      * Get a Stream of events for the authenticated user.
      *
-     * GET /events
+     * <pre><code>GitLab Endpoint: GET /events</code></pre>
      *
      * @param action include only events of a particular action type, optional
      * @param targetType include only events of a particular target type, optional
@@ -115,7 +115,7 @@ public Stream<Event> getAuthenticatedUserEventsStream(ActionType action, TargetT
     /**
      * Get a list of events for the specified user.
      *
-     * GET /users/:userId/events
+     * <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
      *
      * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
      * @param action include only events of a particular action type, optional
@@ -134,7 +134,7 @@ public List<Event> getUserEvents(Object userIdOrUsername, ActionType action, Tar
     /**
      * Get a list of events for the specified user and in the specified page range.
      *
-     * GET /users/:userId/events
+     * <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
      *
      * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
      * @param action include only events of a particular action type, optional
@@ -167,7 +167,7 @@ public List<Event> getUserEvents(Object userIdOrUsername, ActionType action, Tar
     /**
      * Get a list of events for the specified user and in the specified page range.
      *
-     * GET /users/:userId/events
+     * <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
      *
      * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
      * @param action include only events of a particular action type, optional
@@ -196,7 +196,7 @@ public Pager<Event> getUserEvents(Object userIdOrUsername, ActionType action, Ta
     /**
      * Get a Stream of events for the specified user.
      *
-     * GET /users/:userId/events
+     * <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
      *
      * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
      * @param action include only events of a particular action type, optional
@@ -215,7 +215,7 @@ public Stream<Event> getUserEventsStream(Object userIdOrUsername, ActionType act
     /**
      * Get a list of events for the specified project.
      *
-     * GET /:projectId/events
+     * <pre><code>GitLab Endpoint: GET /:projectId/events</code></pre>
      *
      * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param action include only events of a particular action type, optional
@@ -234,7 +234,7 @@ public List<Event> getProjectEvents(Object projectIdOrPath, ActionType action, T
     /**
      * Get a list of events for the specified project and in the specified page range.
      *
-     * GET /projects/:projectId/events
+     * <pre><code>GitLab Endpoint: GET /projects/:projectId/events</code></pre>
      *
      * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param action include only events of a particular action type, optional
@@ -267,7 +267,7 @@ public List<Event> getProjectEvents(Integer projectIdOrPath, ActionType action,
     /**
      * Get a list of events for the specified project and in the specified page range.
      *
-     * GET /projects/:projectId/events
+     * <pre><code>GitLab Endpoint: GET /projects/:projectId/events</code></pre>
      *
      * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param action include only events of a particular action type, optional
@@ -296,7 +296,7 @@ public Pager<Event> getProjectEvents(Object projectIdOrPath, ActionType action,
     /**
      * Get a Stream of events for the specified project.
      *
-     * GET /:projectId/events
+     * <pre><code>GitLab Endpoint: GET /:projectId/events</code></pre>
      *
      * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param action include only events of a particular action type, optional

src/main/java/org/gitlab4j/api/HealthCheckApi.java

@@ -18,7 +18,7 @@ public HealthCheckApi(GitLabApi gitLabApi) {
      * Requires ip_whitelist, see the following link for more info:
      * See <a href="https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html">https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html</a>
      *
-     * GET /-/liveness
+     * <pre><code>GitLab Endpoint: GET /-/liveness</code></pre>
      *
      * @return HealthCheckInfo instance
      * @throws GitLabApiException if any exception occurs
@@ -30,7 +30,7 @@ public HealthCheckInfo getLiveness() throws GitLabApiException {
     /**
      * Get Health Checks from the liveness endpoint.
      *
-     * GET /-/liveness
+     * <pre><code>GitLab Endpoint: GET /-/liveness</code></pre>
      *
      * @param token Health Status token
      * @return HealthCheckInfo instance
@@ -54,7 +54,7 @@ public HealthCheckInfo getLiveness(String token) throws GitLabApiException {
      * Requires ip_whitelist, see the following link for more info:
      * See <a href="https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html">https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html</a>
      *
-     * GET /-/readiness
+     * <pre><code>GitLab Endpoint: GET /-/readiness</code></pre>
      *
      * @return HealthCheckInfo instance
      * @throws GitLabApiException if any exception occurs
@@ -66,7 +66,7 @@ public HealthCheckInfo getReadiness() throws GitLabApiException {
     /**
      * Get Health Checks from the readiness endpoint.
      *
-     * GET /-/readiness
+     * <pre><code>GitLab Endpoint: GET /-/readiness</code></pre>
      *
      * @param token Health Status token
      * @return HealthCheckInfo instance

src/main/java/org/gitlab4j/api/NotificationSettingsApi.java

@@ -14,7 +14,7 @@ public NotificationSettingsApi(GitLabApi gitLabApi) {
     /**
      * Get the global notification settings.
      * 
-     * GET /notification_settings
+     * <pre><code>GitLab Endpoint: GET /notification_settings</code></pre>
      *
      * @return a NotificationSettings instance containing the global notification settings
      * @throws GitLabApiException if any exception occurs
@@ -27,7 +27,7 @@ public NotificationSettings getGlobalNotificationSettings() throws GitLabApiExce
     /**
      * Update the global notification settings.
      * 
-     * PUT /notification_settings
+     * <pre><code>GitLab Endpoint: PUT /notification_settings</code></pre>
      *
      * @param settings a NotificationSettings instance with the new settings
      * @return a NotificationSettings instance containing the updated global notification settings
@@ -62,7 +62,7 @@ public NotificationSettings updateGlobalNotificationSettings(NotificationSetting
     /**
      * Get the notification settings for a group.
      * 
-     * GET /groups/:id/notification_settings
+     * <pre><code>GitLab Endpoint: GET /groups/:id/notification_settings</code></pre>
      *
      * @param groupId the group ID to get the notification settings for
      * @return a NotificationSettings instance containing the specified group's notification settings
@@ -76,7 +76,7 @@ public NotificationSettings getGroupNotificationSettings(int groupId) throws Git
     /**
      * Update the notification settings for a group
      * 
-     * PUT /groups/:id/notification_settings
+     * <pre><code>GitLab Endpoint: PUT /groups/:id/notification_settings</code></pre>
      *
      * @param groupId the group ID to update the notification settings for
      * @param settings a NotificationSettings instance with the new settings
@@ -112,7 +112,7 @@ public NotificationSettings updateGroupNotificationSettings(int groupId, Notific
     /**
      * Get the notification settings for a project.
      * 
-     * GET /projects/:id/notification_settings
+     * <pre><code>GitLab Endpoint: GET /projects/:id/notification_settings</code></pre>
      *
      * @param projectId the project ID to get the notification settings for
      * @return a NotificationSettings instance containing the specified project's notification settings
@@ -126,7 +126,7 @@ public NotificationSettings getProjectNotificationSettings(int projectId) throws
     /**
      * Update the notification settings for a project
      * 
-     * PUT /projects/:id/notification_settings
+     * <pre><code>GitLab Endpoint: PUT /projects/:id/notification_settings</code></pre>
      *
      * @param projectId the project ID to update the notification settings for
      * @param settings a NotificationSettings instance with the new settings