Skip to content

Commit 638327d

Browse files
committed
Cleaned up Javadocs.
1 parent a8de5aa commit 638327d

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ public File downloadExport(Object projectIdOrPath, File directory) throws GitLab
140140
* <li>publicJobs (optional) - If true, jobs can be viewed by non-project-members</li>
141141
* <li>onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs</li>
142142
* <li>onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved</li>
143-
* <li>lLfsEnabled (optional) - Enable LFS</li>
143+
* <li>lfsEnabled (optional) - Enable LFS</li>
144144
* <li>requestAccessEnabled (optional) - Allow users to request member access</li>
145145
* <li>repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins</li>
146146
* <li>approvalsBeforeMerge (optional) - How many approvers should approve merge request by default</li>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -825,7 +825,7 @@ public Project createProject(Project project) throws GitLabApiException {
825825
* publicJobs (optional) - If true, jobs can be viewed by non-project-members
826826
* onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs
827827
* onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved
828-
* lLfsEnabled (optional) - Enable LFS
828+
* lfsEnabled (optional) - Enable LFS
829829
* requestAccessEnabled (optional) - Allow users to request member access
830830
* repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins
831831
* approvalsBeforeMerge (optional) - How many approvers should approve merge request by default
@@ -1065,7 +1065,7 @@ public Project createProject(String name, Integer namespaceId, String descriptio
10651065
* publicJobs (optional) - If true, jobs can be viewed by non-project-members
10661066
* onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs
10671067
* onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved
1068-
* lLfsEnabled (optional) - Enable LFS
1068+
* lfsEnabled (optional) - Enable LFS
10691069
* requestAccessEnabled (optional) - Allow users to request member access
10701070
* repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins
10711071
* approvalsBeforeMerge (optional) - How many approvers should approve merge request by default

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
import org.gitlab4j.api.models.AccessLevel;
1010
import org.gitlab4j.api.models.ProtectedBranch;
1111

12+
/**
13+
* This class provides an entry point to all the Protected Branches API calls.
14+
* @see <a https://docs.gitlab.com/ee/api/protected_branches.html">Protected branches API at GitLab</a>
15+
*/
1216
public class ProtectedBranchesApi extends AbstractApi {
1317

1418
public ProtectedBranchesApi(GitLabApi gitLabApi) {
@@ -62,7 +66,7 @@ public Stream<ProtectedBranch> getProtectedBranchesStream(Object projectIdOrPath
6266
* <pre><code>GitLab Endpoint: DELETE /projects/:id/protected_branches/:name</code></pre>
6367
*
6468
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
65-
* @param branchName the name of the branch to un-protect
69+
* @param branchName the name of the branch to un-protect, can be a wildcard
6670
* @throws GitLabApiException if any exception occurs
6771
*/
6872
public void unprotectBranch(Integer projectIdOrPath, String branchName) throws GitLabApiException {
@@ -75,7 +79,7 @@ public void unprotectBranch(Integer projectIdOrPath, String branchName) throws G
7579
* <pre><code>GitLab Endpoint: POST /projects/:id/protected_branches</code></pre>
7680
*
7781
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
78-
* @param branchName the name of the branch to protect
82+
* @param branchName the name of the branch to protect, can be a wildcard
7983
* @return the branch info for the protected branch
8084
* @throws GitLabApiException if any exception occurs
8185
*/
@@ -89,7 +93,7 @@ public ProtectedBranch protectBranch(Integer projectIdOrPath, String branchName)
8993
* <pre><code>GitLab Endpoint: POST /projects/:id/protected_branches</code></pre>
9094
*
9195
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
92-
* @param branchName the name of the branch to protect
96+
* @param branchName the name of the branch to protect, can be a wildcard
9397
* @param pushAccessLevel Access levels allowed to push (defaults: 40, maintainer access level)
9498
* @param mergeAccessLevel Access levels allowed to merge (defaults: 40, maintainer access level)
9599
* @return the branch info for the protected branch

0 commit comments

Comments
 (0)