[FLINK-12395] Add more detailed javadoc for getDescription() and getDetailedDescription() in catalog object interfaces

• Type: Technical Debt
• Status: In Progress
• Priority: Not a Priority
• Resolution: Unresolved
• Component/s: Table SQL / API
• Labels: auto-deprioritized-major auto-deprioritized-minor pull-request-available
• Assignee: Unassigned
• Reporter: Bowen Li
• Created: 02/May/19 21:40
• Updated: 18/Apr/22 22:38

Description

We need to add more javadoc for getDescritpion() and getDetailedDescription() APIs in CatalogBaseTable, including in which cases they will be called, and how we expect developers to implement them

Issue Links

• Is contained by: FLINK-11275 Unified Catalog APIs
• links to: GitHub Pull Request #8340