azure-sdk-for-java icon indicating copy to clipboard operation
azure-sdk-for-java copied to clipboard

Where is Javadoc for Azure Java Libraries

Open CaymanTurtleBeach opened this issue 1 year ago • 3 comments

Type of issue

Missing information

Description

Why does Microsoft persist in not making links to Javadoc style documentation for Azure Java SDKs PROMINENT - especially when its own format style often omits key elements.

To wit: (from https://learn.microsoft.com/en-us/java/api/com.azure.data.tables.tableserviceclient?view=azure-java-stable#com-azure-data-tables-tableserviceclient-createtable(java-lang-string)

Method Details

Create Table
createTable
public TableClient createTable(String tableName)

Creates a table within the Tables service.

Code Samples

Creates a table. Prints out the details of the created table.

Java

Copy
TableClient tableClient = tableServiceClient.createTable("myTable");

 System.out.printf("Table with name '%s' was created.", tableClient.getTableName());
Parameters:

tableName - The name of the table to create.
Returns:

A [TableClient](https://learn.microsoft.com/en-us/java/api/com.azure.data.tables.tableclient?view=azure-java-stable) for the created table.

NOT A WORD ABOUT THE EXCEPTION THAT IS THROWN IF A TABLE WITH THE NAME tableName ALREADY EXISTS.

Where is Javadoc??? Java developers should not have to search for Javadoc and slog through all the cruft returned just to get documentation that is correct and formatted consistent with virtually all significant public Java libraries.

Page URL

https://learn.microsoft.com/en-us/java/api/overview/azure/data-tables-readme?view=azure-java-stable

Content source URL

https://github.com/Azure/azure-docs-sdk-java/blob/master/docs-ref-services/latest/data-tables-readme.md

Document Version Independent Id

c2ca723f-f9ca-302a-6a30-9426fdb8b0cc

Article author

@azure-sdk

Metadata

  • ID: a618277f-b2f6-1c9d-551c-14e0adea3738
  • Service: tables

CaymanTurtleBeach avatar Apr 28 '24 18:04 CaymanTurtleBeach

Thank you for your feedback. Tagging and routing to the team member best able to assist.

github-actions[bot] avatar Apr 28 '24 18:04 github-actions[bot]

@CaymanTurtleBeach Thank you for reaching out. I will look into your issue and respond shortly.

jairmyree avatar Apr 29 '24 17:04 jairmyree

@CaymanTurtleBeach There is a known issue with the learn.microsoft.com documentation where the exceptions are not being documented. For more accurate documentation, I would suggest that you use the Javadocs that come bundled with each release of our libraries: link to maven. They can be directly downloaded from maven and viewed within your browser or viewed within an IDE capable of downloading and displaying dependency Javadocs such as Intellij.

jairmyree avatar Apr 29 '24 17:04 jairmyree

Hi @CaymanTurtleBeach. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

github-actions[bot] avatar May 07 '24 17:05 github-actions[bot]