Support Object Oriented Interfaces with documentation for Libraries [36754997]

Assigned

Feature Request

Status Update

No update yet.

Description

ed...@gmail.com

created issue #1

Jun 6, 2012 12:00AM

Request Summary:

Currently Google Apps Scripts uses JSDoc on Apps Script Libraries to auto-complete functions on the top of the library.

Still there's no way to document namespaced functions or classes. Only the top level functions will auto-complete.

Notes:
More Info:

http://stackoverflow.com/questions/10890177/creating-a-namespace-like-organization-in-a-google-apps-script-library/10893170#comment14220850_10893170

Comments

jk...@google.com <jk...@google.com> Jun 8, 2012 01:24AM

Assigned to jk...@google.com.

ma...@gmail.com <ma...@gmail.com> #2Nov 22, 2012 03:36PM

Any word on this?

de...@iboapp.info <de...@iboapp.info> #3Oct 25, 2013 02:58PM

I suppose as long as the workarounds with API library project work, there will be no need to improve it. see

https://plus.google.com/104403800912062884925/posts/H75XFQxtHkc

ca...@gmail.com <ca...@gmail.com> #4Mar 4, 2014 01:54AM

I was reading this article :

https://developers.google.com/closure/compiler/docs/js-for-compiler

Yet I couldn't document my "enums" with @enum. I guess this is the same issue. Only the first level functions seem to be documented properly.

ek...@google.com <ek...@google.com> #5Apr 10, 2014 04:19PM

Reassigned to ap...@google.com.

Unassigning

zi...@zizix.org <zi...@zizix.org> #6Oct 11, 2014 02:07PM

this problem hinders the development of GAS in the direction of user libraries.

[Deleted User] <[Deleted User]> #7Jul 21, 2016 03:17PM

Checking in on this item. This would be an amazingly helpful functionality and assist greatly in efforts to generate open-source libraries that instantiate classes.

[Deleted User] <[Deleted User]> #8Dec 21, 2017 03:06AM

very interested in this as well. Please help Google!!! You're our only hope!! ...oh yeah and update to ECMA 6

D:

Thanks :D

[Deleted User] <[Deleted User]> #9Feb 16, 2018 07:06AM

jo...@gmail.com <jo...@gmail.com> #10Nov 16, 2018 04:53AM

ma...@gmail.com <ma...@gmail.com> #11Dec 18, 2018 05:51AM

I hope the one issue blocking this is to convert the thinking at Google to more of a predictable, typed paradigm - and I hope it happens soon!

ma...@bkper.com <ma...@bkper.com> #12Sep 16, 2019 10:11AM

Hi guys,

If you are working with TypeScript, we've built a package that aims solve this:

https://github.com/maelcaldas/clasp-types

We use it internally to generate autocomplete for OO libraries and Client-side API written on Typescript.

Happy to have your feedbacks on that.

Message last modified on Sep 16, 2019 10:12AM

[Deleted User] <[Deleted User]> #13Jan 20, 2020 05:10PM

jo...@appier.com <jo...@appier.com> #14Apr 21, 2020 01:30AM

je...@dp6.com.br <je...@dp6.com.br> #15Aug 21, 2020 07:15AM

pr...@gmail.com <pr...@gmail.com> #16Dec 15, 2020 03:05PM

bo...@gmail.com <bo...@gmail.com> #17Jun 24, 2021 11:48PM

an...@google.com <an...@google.com> #18Jun 29, 2021 10:48AM

Reassigned to an...@google.com.

Hi there!

I've made a new internal report. If we have any updates or inquiries, we'll post them here.

Cheers!

[Deleted User] <[Deleted User]> #19Jul 30, 2021 08:17PM

+1 here, in case we get any updates on that :)

gi...@gmail.com <gi...@gmail.com> #20Sep 25, 2021 01:10PM

+1 here too

is...@google.com <is...@google.com> Nov 21, 2021 07:06AM

Status: New

ra...@cloudgarden.pl <ra...@cloudgarden.pl> #21Nov 21, 2021 11:12AM

jo...@campusinternationalschool.org <jo...@campusinternationalschool.org> #22Dec 26, 2021 06:27PM

w4...@gmail.com <w4...@gmail.com> #23Mar 17, 2022 09:58AM

Comment has been deleted.

Message last modified on Mar 17, 2022 09:59AM

al...@gmail.com <al...@gmail.com> #24Mar 17, 2022 09:59AM

al...@lyft.com <al...@lyft.com> #25Apr 20, 2022 04:44AM

he...@gmail.com <he...@gmail.com> #26Sep 4, 2022 08:34PM

ze...@gmail.com <ze...@gmail.com> #27Oct 30, 2022 02:42PM

[Deleted User] <[Deleted User]> #28Nov 25, 2022 03:30PM

mm...@gmail.com <mm...@gmail.com> #29Dec 23, 2022 09:31PM

ab...@gmail.com <ab...@gmail.com> #30Feb 20, 2023 04:46PM

This is very important when sharing the AppScript code as library. Easy Documentation should be available for Object Oriented Interfaces e.g.

var a= function(){

//need to share the documentations for using this function when sharing library
this.action=function(){
}
}

tg...@gmail.com <tg...@gmail.com> #31Jun 5, 2023 08:00AM

11 years...
shame on google

jp...@google.com <jp...@google.com> Jul 13, 2023 03:38AM

Assigned to wo...@google.com.

dr...@gmail.com <dr...@gmail.com> #32Sep 16, 2023 04:27PM

kr...@gmail.com <kr...@gmail.com> #33Dec 15, 2023 11:30PM

vi...@gmail.com <vi...@gmail.com> #34May 15, 2024 12:44PM

do...@luxemporiumusa.com <do...@luxemporiumusa.com> #35Jun 6, 2024 08:06PM

an...@gmail.com <an...@gmail.com> #36Aug 10, 2024 04:09PM

Might as well get the autocomplete supported without even the JSDoc as it added new learning curve and lengthened development time. In-depth JSDoc auto-complete support offers little value in return -- more work for both Google and the app script developers.

ri...@gmail.com <ri...@gmail.com> #37Mar 23, 2025 03:21PM

+1

Any update here?
Its very confusing if the library just store all the function name.