search

kayler-renslow / arma-intellij-plugin

A plugin for Intellij IDEA that allows for syntactical analysis, code inspections, and other nifty features for the SQF scripting language in Arma 3.
MIT License
41 stars 10 forks source link

cfgFunctions And Documentation #45

Open Ragebone opened 7 years ago

Ragebone commented 7 years ago

Plugin Version

1.0.7

Summary

Documentation not working for custom functions.

Detail

Your ctrl + Q documentation for BIS commands and functions is awesome. But it doesn't work for my custom functions for some weird reason. Auto completion works fine, ruling out a bad CfgFunctions, but opening the documentation just gives "no documentation found" even though there is a nice big comment up top.

It could be the folder-structure: @SomeMod addons ModulAddon1 ModulAddon2 ...

But the completion works as intended so whats wrong?

Thanks a lot! Sincerely Rage

kayler-renslow commented 7 years ago

Could you attach a snippet of your description.ext file as well as a screenshot of your project directory (should include description.ext, sqf files, header files, etc) ?

Ragebone commented 7 years ago

Of cause.

Our moular project addon structure. project_structure

and the description.ext of the development addon that i'm currently working on. Just functions for some purposes.

This has not been loaded into Arma jet, so if there is a mistake regarding the file path tags, that might explain it, but i have checked them 3 times now.
I could be blind of cause, but i checked other addons too and some of them were loaded and work, but still no documentation.

description_ext

Another observation: The right-click menu on a directory just gives me "create SQF File" not the function option anymore. But i can't take a picture of it.

Let me know if you need anything else, thanks for your time and this awesome Plugin!

kayler-renslow commented 7 years ago

Thanks for these screenshots. I see the issue now.

The plugin is able to locate the functions because the class names are written in the description.ext. When it comes to function documentation, it entirely depends if the plugin can find the file or not. The plugin is currently hard coded to ignore file paths that start with "/" or "\" because the plugin isn't intelligent enough to know how mods work. Mod support is something that I would like to have implemented, but for now you will have to live without the documentation. Sorry. :)

The "create config function" option was removed until something better could be implemented.