Add comprehensive JSDoc documentation to src/api.d.ts#17113

Copilot wants to merge 2 commits intomainmicrosoft/vscode-jupyter:mainfrom

copilot/add-comments-to-api-filemicrosoft/vscode-jupyter:copilot/add-comments-to-api-fileCopy head branch name to clipboard