From 6561c93aafa6bf35cb9bad0617127a0c249a8f9f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Bresson?= <jeremie.bresson@unblu.com>
Date: Tue, 7 Nov 2023 23:22:02 +0100
Subject: [PATCH] Add GitLab endpoints to the javadoc (#1033)

---
 src/main/java/org/gitlab4j/api/NotesApi.java | 21 ++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/main/java/org/gitlab4j/api/NotesApi.java b/src/main/java/org/gitlab4j/api/NotesApi.java
index df641aac9..54ca2b529 100644
--- a/src/main/java/org/gitlab4j/api/NotesApi.java
+++ b/src/main/java/org/gitlab4j/api/NotesApi.java
@@ -131,6 +131,8 @@ public Stream<Note> getIssueNotesStream(Object projectIdOrPath, Long issueIid) t
     /**
      * Get the specified issues's note.
      *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param issueIid the issue IID to get the notes for
      * @param noteId the ID of the Note to get
@@ -145,6 +147,9 @@ public Note getIssueNote(Object projectIdOrPath, Long issueIid, Long noteId) thr
 
     /**
      * Create a issues's note.
+     *
+     * <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance @param projectIdOrPath the project ID to create the issues for
      * @param issueIid the issue IID to create the notes for
      * @param body the content of note
@@ -158,6 +163,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body)
     /**
      * Create a issues's note.
      *
+     * <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param issueIid the issue IID to create the notes for
      * @param body the content of note
@@ -171,6 +178,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body,
     /**
      * Create a issues's note.
      *
+     * <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param issueIid the issue IID to create the notes for
      * @param body the content of note
@@ -194,6 +203,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body,
     /**
      * Update the specified issues's note.
      *
+     * <pre><code>GitLab Endpoint: PUT /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param issueIid the issue IID to update the notes for
      * @param noteId the ID of the node to update
@@ -212,6 +223,8 @@ public Note updateIssueNote(Object projectIdOrPath, Long issueIid, Long noteId,
     /**
      * Delete the specified issues's note.
      *
+     * <pre><code>GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param issueIid the issue IID to delete the notes for
      * @param noteId the ID of the node to delete
@@ -378,6 +391,8 @@ public Stream<Note> getMergeRequestNotesStream(Object projectIdOrPath, Long merg
     /**
      * Get the specified merge request's note.
      *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param mergeRequestIid  the merge request IID to get the notes for
      * @param noteId the ID of the Note to get
@@ -393,6 +408,8 @@ public Note getMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Lo
     /**
      * Create a merge request's note.
      *
+     * <pre><code>GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param mergeRequestIid  the merge request IID to create the notes for
      * @param body the content of note
@@ -409,6 +426,8 @@ public Note createMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid,
     /**
      * Update the specified merge request's note.
      *
+     * <pre><code>GitLab Endpoint: PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param mergeRequestIid  the merge request IID to update the notes for
      * @param noteId the ID of the node to update
@@ -427,6 +446,8 @@ public Note updateMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid,
     /**
      * Delete the specified merge request's note.
      *
+     * <pre><code>GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
+     *
      * @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
      * @param mergeRequestIid the merge request IID to delete the notes for
      * @param noteId the ID of the node to delete