Skip to content

Commit 5aca498

Browse files
authored
Add missing Javadocs for resourcemanagerhybrid (Azure#25770)
1 parent 36ff5e1 commit 5aca498

File tree

49 files changed

+1950
-17
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1950
-17
lines changed

sdk/resourcemanagerhybrid/azure-resourcemanager-appservice/pom.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939
<!-- RMJacoco -->
4040
<jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
4141
<jacoco.min.branchcoverage>0.10</jacoco.min.branchcoverage>
42+
<codesnippet.skip>false</codesnippet.skip>
43+
<javadocDoclet></javadocDoclet>
44+
<javadocDocletOptions></javadocDocletOptions>
4245
</properties>
4346

4447
<developers>

sdk/resourcemanagerhybrid/azure-resourcemanager-appservice/src/main/java/com/azure/resourcemanager/appservice/models/DomainContact.java

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,12 @@ interface WithPhoneNumber<ParentT> {
257257
* @param <ParentT> the stage of the parent definition to return to after attaching
258258
*/
259259
interface WithFaxNumber<ParentT> {
260+
/**
261+
* Specifies the fax number.
262+
*
263+
* @param faxNumber the fax number
264+
* @return the next stage of the definition
265+
*/
260266
WithAttach<ParentT> withFaxNumber(String faxNumber);
261267
}
262268

@@ -266,6 +272,12 @@ interface WithFaxNumber<ParentT> {
266272
* @param <ParentT> the stage of the parent definition to return to after attaching
267273
*/
268274
interface WithOrganization<ParentT> {
275+
/**
276+
* Specifies the organization.
277+
*
278+
* @param organziation the organization
279+
* @return the next stage of the definition
280+
*/
269281
WithAttach<ParentT> withOrganization(String organziation);
270282
}
271283

@@ -275,6 +287,12 @@ interface WithOrganization<ParentT> {
275287
* @param <ParentT> the stage of the parent definition to return to after attaching
276288
*/
277289
interface WithJobTitle<ParentT> {
290+
/**
291+
* Specifies the job title.
292+
*
293+
* @param jobTitle the job title
294+
* @return the next stage of the definition
295+
*/
278296
WithAttach<ParentT> withJobTitle(String jobTitle);
279297
}
280298

@@ -291,6 +309,9 @@ interface WithAttach<ParentT>
291309
DefinitionStages.WithOrganization<ParentT>,
292310
DefinitionStages.WithJobTitle<ParentT>,
293311
DefinitionStages.WithFaxNumber<ParentT> {
312+
/**
313+
* @return the contact
314+
*/
294315
Contact build();
295316
}
296317
}

sdk/resourcemanagerhybrid/azure-resourcemanager-authorization/pom.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939
<!-- RMJacoco -->
4040
<jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
4141
<jacoco.min.branchcoverage>0.10</jacoco.min.branchcoverage>
42+
<codesnippet.skip>false</codesnippet.skip>
43+
<javadocDoclet></javadocDoclet>
44+
<javadocDocletOptions></javadocDocletOptions>
4245
</properties>
4346

4447
<developers>

sdk/resourcemanagerhybrid/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/ActiveDirectoryGroup.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ interface Blank extends WithEmailAlias {
4949

5050
/** An AD Group definition allowing mail nickname to be specified. */
5151
interface WithEmailAlias {
52+
/**
53+
* Adds an email alias.
54+
*
55+
* @param mailNickname the Active Directory object's email alias
56+
* @return the next AD Group definition stage
57+
*/
5258
WithCreate withEmailAlias(String mailNickname);
5359
}
5460

sdk/resourcemanagerhybrid/azure-resourcemanager-compute/pom.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939
<!-- RMJacoco -->
4040
<jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
4141
<jacoco.min.branchcoverage>0.10</jacoco.min.branchcoverage>
42+
<codesnippet.skip>false</codesnippet.skip>
43+
<javadocDoclet></javadocDoclet>
44+
<javadocDocletOptions></javadocDocletOptions>
4245
</properties>
4346

4447
<developers>

sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/GalleryImage.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,9 @@ interface WithIdentifier {
197197
WithOsTypeAndState withIdentifier(String publisher, String offer, String sku);
198198
}
199199

200+
/**
201+
* The stage of the gallery image definition allowing to specify the OS type and state.
202+
*/
200203
interface WithOsTypeAndState {
201204
/**
202205
* Specifies that image is a Windows image with OS state as generalized.

sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/VirtualMachineCustomImage.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,12 @@ interface WithOSDiskImageSourceAltVirtualMachineSource extends WithOSDiskImageSo
6767
* not added will be hyperV gen 1.
6868
*/
6969
interface WithHyperVGeneration extends WithOSDiskImageSourceAltVirtualMachineSource {
70+
/**
71+
* Specifies the Hyper-V generation.
72+
*
73+
* @param hyperVGeneration the Hyper-V generation
74+
* @return the next stage of the definition
75+
*/
7076
WithOSDiskImageSourceAltVirtualMachineSource withHyperVGeneration(HyperVGenerationTypes hyperVGeneration);
7177
}
7278

sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/VirtualMachineEncryptionConfiguration.java

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,54 @@
1616
* @param <T> type presenting Windows or Linux specific settings
1717
*/
1818
public abstract class VirtualMachineEncryptionConfiguration<T extends VirtualMachineEncryptionConfiguration<T>> {
19+
/**
20+
* The KeyVault ID.
21+
*/
1922
protected final String keyVaultId;
23+
24+
/**
25+
* The AAD client ID.
26+
*/
2027
protected final String aadClientId;
28+
29+
/**
30+
* The AAD secret.
31+
*/
2132
protected final String aadSecret;
33+
34+
/**
35+
* The volume type.
36+
*/
2237
protected DiskVolumeType volumeType = DiskVolumeType.ALL;
38+
39+
/**
40+
* The key encryption key URL.
41+
*/
2342
protected String keyEncryptionKeyUrl;
43+
44+
/**
45+
* The key encryption key KeyVault ID.
46+
*/
2447
protected String keyEncryptionKeyVaultId;
48+
49+
/**
50+
* The encryption algorithm.
51+
*/
2552
protected String encryptionAlgorithm = "RSA-OAEP";
53+
54+
/**
55+
* The pass phrase.
56+
*/
2657
protected String passPhrase;
58+
59+
/**
60+
* The AzureEnvironment.
61+
*/
2762
protected final AzureEnvironment azureEnvironment;
63+
64+
/**
65+
* The KeyVault URI.
66+
*/
2867
protected final String vaultUri;
2968

3069
/**

sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/VirtualMachineScaleSet.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -555,8 +555,6 @@ interface WithPrimaryInternetFacingLoadBalancer {
555555
* <p>By default, all the backends and inbound NAT pools of the load balancer will be associated with the
556556
* primary network interface of the scale set virtual machines.
557557
*
558-
* <p>
559-
*
560558
* @param loadBalancer an existing Internet-facing load balancer
561559
* @return the next stage of the definition
562560
*/
@@ -584,8 +582,6 @@ interface WithPrimaryInternalLoadBalancer {
584582
* primary network interface of the virtual machines in the scale set, unless subset of them is selected in
585583
* the next stages.
586584
*
587-
* <p>
588-
*
589585
* @param loadBalancer an existing internal load balancer
590586
* @return the next stage of the definition
591587
*/
@@ -1017,6 +1013,11 @@ interface WithLinuxCreateUnmanaged extends WithUnmanagedCreate {
10171013
* for the resource to be created, but also allows for any other optional settings to be specified.
10181014
*/
10191015
interface WithWindowsCreateManagedOrUnmanaged extends WithWindowsCreateManaged {
1016+
/**
1017+
* Enables unmanaged disks.
1018+
*
1019+
* @return the next stage of the definition
1020+
*/
10201021
WithWindowsCreateUnmanaged withUnmanagedDisks();
10211022
}
10221023

sdk/resourcemanagerhybrid/azure-resourcemanager-containerregistry/pom.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@
3535
<!-- RMJacoco -->
3636
<jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
3737
<jacoco.min.branchcoverage>0.05</jacoco.min.branchcoverage>
38+
<codesnippet.skip>false</codesnippet.skip>
39+
<javadocDoclet></javadocDoclet>
40+
<javadocDocletOptions></javadocDocletOptions>
3841
</properties>
3942

4043
<developers>

0 commit comments

Comments
 (0)