-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[MNG-8610] Add javadoc for all o.a.m.api packages #2142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
34 changes: 34 additions & 0 deletions
34
api/maven-api-cli/src/main/java/org/apache/maven/api/cli/extensions/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides support for Maven core extensions configuration and management. | ||
| * Core extensions can be configured through {@code .mvn/extensions.xml} in the project | ||
| * base directory to enhance Maven's capabilities during build execution. | ||
| * | ||
| * <p>This package contains classes for:</p> | ||
| * <ul> | ||
| * <li>Extension configuration model</li> | ||
| * <li>Extension loading and validation</li> | ||
| * <li>Extension lifecycle management</li> | ||
| * </ul> | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.cli.extensions; |
34 changes: 34 additions & 0 deletions
34
api/maven-api-cli/src/main/java/org/apache/maven/api/cli/logging/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides early-stage logging capabilities for Maven CLI operations. | ||
| * These logging facilities are used during Maven startup before the full logging | ||
| * system is initialized. | ||
| * | ||
| * <p>This package includes:</p> | ||
| * <ul> | ||
| * <li>Basic logging interfaces and implementations</li> | ||
| * <li>Support for different logging levels (DEBUG, INFO, WARN, ERROR)</li> | ||
| * <li>Accumulating loggers for deferred output</li> | ||
| * </ul> | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.cli.logging; |
38 changes: 38 additions & 0 deletions
38
api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides the API for the Maven build tool ({@code mvn}). | ||
| * | ||
| * <p>This package contains interfaces and classes specific to the main Maven build | ||
| * tool, which is responsible for project build lifecycle execution and dependency management.</p> | ||
| * | ||
| * <p>Key features include:</p> | ||
| * <ul> | ||
| * <li>Build lifecycle execution control</li> | ||
| * <li>Project-specific configuration</li> | ||
| * <li>Goal execution and phase mapping</li> | ||
| * <li>Multi-module build coordination</li> | ||
| * </ul> | ||
| * | ||
| * @see org.apache.maven.api.cli.Tools#MVN_CMD | ||
| * @see org.apache.maven.api.cli.Tools#MVN_NAME | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.cli.mvn; |
37 changes: 37 additions & 0 deletions
37
api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvnenc/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides the API for the Maven Password Encryption tool ({@code mvnenc}). | ||
| * | ||
| * <p>This package contains interfaces and classes for the password encryption tool, | ||
| * which helps secure sensitive information in Maven settings and configuration files.</p> | ||
| * | ||
| * <p>Key features include:</p> | ||
| * <ul> | ||
| * <li>Password encryption and decryption</li> | ||
| * <li>Master password management</li> | ||
| * <li>Security settings configuration</li> | ||
| * </ul> | ||
| * | ||
| * @see org.apache.maven.api.cli.Tools#MVNENC_CMD | ||
| * @see org.apache.maven.api.cli.Tools#MVNENC_NAME | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.cli.mvnenc; |
39 changes: 39 additions & 0 deletions
39
api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvnsh/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides the API for the Maven Shell tool ({@code mvnsh}). | ||
| * | ||
| * <p>This package contains interfaces and classes for the interactive Maven shell, | ||
| * which provides a command-line interface for executing Maven commands and | ||
| * managing build environments.</p> | ||
| * | ||
| * <p>Key features include:</p> | ||
| * <ul> | ||
| * <li>Interactive command-line interface</li> | ||
| * <li>Command history and completion</li> | ||
| * <li>Built-in shell commands</li> | ||
| * <li>Project navigation and management</li> | ||
| * </ul> | ||
| * | ||
| * @see org.apache.maven.api.cli.Tools#MVNSHELL_CMD | ||
| * @see org.apache.maven.api.cli.Tools#MVNSHELL_NAME | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.cli.mvnsh; |
44 changes: 44 additions & 0 deletions
44
api/maven-api-cli/src/main/java/org/apache/maven/api/cli/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides the API for Maven's command-line interface and tools. | ||
| * | ||
| * <p>This package contains interfaces and classes for:</p> | ||
| * <ul> | ||
| * <li>Command-line argument parsing and processing</li> | ||
| * <li>Maven tool invocation ({@code mvn}, {@code mvnenc}, {@code mvnsh})</li> | ||
| * <li>Core extensions configuration</li> | ||
| * <li>Early-stage logging before the full Maven logging system is initialized</li> | ||
| * </ul> | ||
| * | ||
| * <p>The main components are:</p> | ||
| * <ul> | ||
| * <li>{@link org.apache.maven.api.cli.Invoker} - Base interface for executing Maven tools</li> | ||
| * <li>{@link org.apache.maven.api.cli.Parser} - Processes command-line arguments into invoker requests</li> | ||
| * <li>{@link org.apache.maven.api.cli.Options} - Represents Maven configuration options</li> | ||
| * <li>{@link org.apache.maven.api.cli.extensions.CoreExtensions} - Manages Maven core extensions</li> | ||
| * </ul> | ||
| * | ||
| * <p>Core extensions can be configured through {@code .mvn/extensions.xml} in the project base directory | ||
| * to enhance Maven's capabilities during build execution.</p> | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.cli; |
27 changes: 27 additions & 0 deletions
27
api/maven-api-core/src/main/java/org/apache/maven/api/feature/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides feature flag management and configuration capabilities for Maven core functionality. | ||
| * This package allows for controlled enablement and management of Maven features across | ||
| * different execution contexts and environments. | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.feature; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 19 additions & 1 deletion
20
api/maven-api-core/src/main/java/org/apache/maven/api/plugin/annotations/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 19 additions & 1 deletion
20
api/maven-api-core/src/main/java/org/apache/maven/api/plugin/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
api/maven-api-core/src/main/java/org/apache/maven/api/services/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Defines core service interfaces that provide essential Maven functionality such as | ||
| * artifact resolution, dependency management, and build execution. These services | ||
| * form the backbone of Maven's extensible architecture. | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.services; |
27 changes: 27 additions & 0 deletions
27
api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Provides XML-specific services for reading and writing Maven's configuration files | ||
| * and descriptors. These services handle XML parsing, transformation, and serialization | ||
| * while maintaining Maven's model integrity. | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| package org.apache.maven.api.services.xml; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.