20Tauri / DoxyDoxygen

The last word in code documentation generation
140 stars 5 forks source link

autocomplete not working #138

Closed rgokul closed 4 years ago

rgokul commented 4 years ago

I just installed this plugin. However I cant get auto completion to work. I dont see any settings in default doxydoxygen preference for auto_complete_selector that I can override in user settings. Can you please enhance documentation?

20Tauri commented 4 years ago

According to the documentation, the setting to enable is completion_enabled

However some issues are known in Lua, Swift, TypeScript and Perl languages cause completions don't work when cursor was at the end of a comment line (https://github.com/20Tauri/DoxyDoxygen/issues/132, https://github.com/sublimehq/Packages/issues/2127) I will add a workaround in the next release to handle those cases

Can you add an example of what doesn't work. Including:

rgokul commented 4 years ago

I am using it for the C language and doxygen style. When I added a new function into my file and I tried to add its doxygen I see that /** Enter worked. Next I filled brief. Enter. Typed @. no suggestions received. I typed @details pressed tab. It filled out the template for @details. Pressed enter and tried to type @ again for note. No suggestion of available commands.

/**
 * @brief      init foo
 * @details    init foo explicitly
 * @note       blH
 *
 * @return     { description_of_the_return_value }
 */
status_t foo_init(void);
20Tauri commented 4 years ago

Tested on both, Sublime Text 2 & 3. For the first test, as I've the sublime setting auto_complete_selector set to its default (completion disabled in comments), I've to press Ctrl+Space to have the possible choices When I enter @details then Tab, It works as expected

Have you try to enter @d, then press Ctrl+Space. In this case, I have severals suggestions. The DoxyDoxygen ones and the C ones (do def). If you have no suggestion, the problem is probably not DoxyDoxygen

20Tauri commented 4 years ago

Have you try my suggestion ? Have you any idea about the way to enhance documentation ? The auto_complete_selection tip is in the documentation... But you have probably miss it. What section or keywords you have look for to try to find an answer to your question....

This will help to improve the documentation