# ScriptFunctionDocProvider implementation

**URL:** <https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194>\
**Category:** Ignition 8.3 Early Access\
**Created:** [July 7, 2025, 6:26pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194 "2025-07-07T18:26:57Z")\
**Posts on this page:** 11\
**Page:** 1

<div class="post-metadata">

**Author:** ![stevenson](https://avatars.discourse-cdn.com/v4/letter/s/41988e/32.png) [@stevenson](https://forum.inductiveautomation.com/u/stevenson)\
**Post date:** [July 7, 2025, 6:26pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/1 "2025-07-07T18:26:57Z")

</div>

I've updated my pom to use 8.3.0-Snapshot and the beta repo's.

Looks like the legacy methods got replaced by `getMethodDescriptor` and `getFieldDescriptor`.

When trying to override for the methods I'm getting cannot resolve `com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor`.

Am I missing something obvious or should I just refactor my documentation?

---

<div class="post-metadata">

**Author:** ![Vi\_Quang](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/vi_quang/32/82707_2.png) [@Vi\_Quang](https://forum.inductiveautomation.com/u/Vi_Quang)\
**Post date:** [July 8, 2025, 3:44pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/2 "2025-07-08T15:44:06Z")

</div>

Hi stevenson,  
Using the latest SDK, I was able to override those 2 methods without getting the error you described. When you're using your custom ScriptFunctionDocProvider, which hooks (Gateway, Designer, Client) are you applying this to. And where do you see that error?

---

<div class="post-metadata">

**Author:** ![stevenson](https://avatars.discourse-cdn.com/v4/letter/s/41988e/32.png) [@stevenson](https://forum.inductiveautomation.com/u/stevenson)\
**Post date:** [July 8, 2025, 3:54pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/3 "2025-07-08T15:54:56Z")

</div>

My "Docs" files are in common-

 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/a/7/a70e326f1263823a3951a31026eab93c9346280c.png)

My 8.1 source has the script module being added to designer, gw, and client hook.

Trying to browse intellisense for `.typing` just shows empty:  
 ![image](https://us1.discourse-cdn.com/inductiveautomation/optimized/3X/9/5/9510db8361ea40b9a99807d69d731a3d8099f1c4_2_690x53.png)

here's my pom.xml

 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/f/0/f089be309154a69ebd3c6fe729b7e5a4674f407b.png)

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [July 8, 2025, 3:58pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/4 "2025-07-08T15:58:57Z")

</div>

Does your common module have a dependency on `ignition-common` from the SDK?

```xml
    <dependencies>
        <dependency>
            <groupId>com.inductiveautomation.ignitionsdk</groupId>
            <artifactId>ignition-common</artifactId>
            <version>${ignition-sdk-version}</version>
            <type>pom</type>
            <scope>provided</scope>
        </dependency>
    </dependencies>

```

---

<div class="post-metadata">

**Author:** ![stevenson](https://avatars.discourse-cdn.com/v4/letter/s/41988e/32.png) [@stevenson](https://forum.inductiveautomation.com/u/stevenson)\
**Post date:** [July 8, 2025, 4:04pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/5 "2025-07-08T16:04:45Z")

</div>

i believe so, the pom in my common has the same dependency:

 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/9/d/9d1bc1cb6327567321a9a4b1a7a182ea1ef05348.png)

---

<div class="post-metadata">

**Author:** ![Vi\_Quang](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/vi_quang/32/82707_2.png) [@Vi\_Quang](https://forum.inductiveautomation.com/u/Vi_Quang)\
**Post date:** [July 8, 2025, 5:40pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/7 "2025-07-08T17:40:12Z")

</div>

Are you able to compile this outside of the IDE?

---

<div class="post-metadata">

**Author:** ![stevenson](https://avatars.discourse-cdn.com/v4/letter/s/41988e/32.png) [@stevenson](https://forum.inductiveautomation.com/u/stevenson)\
**Post date:** [July 8, 2025, 5:52pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/8 "2025-07-08T17:52:30Z")

</div>

What do you mean by compiling outside of the IDE?

I can run the maven build and it does generate the .modl file, but after installing the module, designer will hang on the splash screen when loading (Initializing Scripting).

---

<div class="post-metadata">

**Author:** ![Vi\_Quang](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/vi_quang/32/82707_2.png) [@Vi\_Quang](https://forum.inductiveautomation.com/u/Vi_Quang)\
**Post date:** [July 8, 2025, 6:16pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/9 "2025-07-08T18:16:13Z")

</div>

That's what I meant, checking to see if it builds without errors.

In the IDE, have you tried right clicking on your main project to bring up a context menu, then select: Maven \> Sync Project.

See if that resolves the error you see in the IDE.

---

<div class="post-metadata">

**Author:** ![stevenson](https://avatars.discourse-cdn.com/v4/letter/s/41988e/32.png) [@stevenson](https://forum.inductiveautomation.com/u/stevenson)\
**Post date:** [July 8, 2025, 6:51pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/10 "2025-07-08T18:51:17Z")

</div>

No luck- still can't resolve CompletionDescriptor after manually re-syncing

---

<div class="post-metadata">

**Author:** ![Vi\_Quang](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/vi_quang/32/82707_2.png) [@Vi\_Quang](https://forum.inductiveautomation.com/u/Vi_Quang)\
**Post date:** [July 8, 2025, 7:24pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/11 "2025-07-08T19:24:36Z")

</div>

I would think that you're grabbing the correct version of the SDK, the one with `com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor`, if you were grabbing the wrong SDK version then it would fail on the `mvn` build. So it's the problem with the IDE not updating with the changes, rebuild the index?

---

<div class="post-metadata">

**Author:** ![stevenson](https://avatars.discourse-cdn.com/v4/letter/s/41988e/32.png) [@stevenson](https://forum.inductiveautomation.com/u/stevenson)\
**Post date:** [July 8, 2025, 9:27pm UTC](https://forum.inductiveautomation.com/t/scriptfunctiondocprovider-implementation/108194/13 "2025-07-08T21:27:53Z")

</div>

I upgraded my install of intellij from 2022 to 2025 and the issue went away. 🤷

thanks for the help!