cschlosser / doxdocgen

Generate doxygen documentation from source code in VS Code
https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen
MIT License
266 stars 56 forks source link

Trigger sequence /** does not work #97

Closed dave2k19 closed 5 years ago

dave2k19 commented 5 years ago

Issue Type: ? Extension Name: doxdocgen Extension Version: 0.4.1 OS Version: Windows 7 Enterprise VS version: 14.0.25431 VSCode version: 1.30.2

Hi,

I have installed the plugin through VSCode but no matter what I do the trigger sequence does not work in my code. I tried to apply it to existing code and also to newly created files (c and cpp) but it just did not trigger. I verified that the plugin is installed and enabled. I also tried different version (0.1 and 0.3) but nothing changed. I also tried to change the sequence itself - but to no avail. Are there any requirements that I have missed or do I need to disable auto-completion of some sort?

Example code test.cpp

void func(int a) { return; }

JasonZhu1313 commented 5 years ago

I encounter this problem as well.

cschlosser commented 5 years ago

Unfortunately I don't have a windows machine around at the moment and my macOS setup works.

Could you please take a look into the JS console of VS Code? Take a look into Help > Toggle Developer Tools for this. A list of your plugins and settings would also be really helpful.

Is vscode detecting your file as C/C++? It should show you in the lower right corner.

JasonZhu1313 commented 5 years ago

Thanks for your reply. Actually, I test it on my mac, and it works for C and C++ but it didn't work for C#, but I think it also supports C# right? Do I need to do some extra configuration for it to work for dot cs file?

cschlosser commented 5 years ago

No, right now it‘s only C and C++.

JonMcDevitt commented 5 years ago

I also encounter this problem. I have attached a zipped .mp4 recording of the issue. Is this not the correct way to configure and use the Doxygen extension?

VSCode_DoxygenExt.zip

cschlosser commented 5 years ago

@JonMcDevitt You have to press "Enter".

It literally say so in the first line of the Extension description.

cschlosser commented 5 years ago

@dave2k19 Could you please report back?

Otherwise I will close this soon

dave2k19 commented 5 years ago

Hi Christoph, sorry for late reply. I got a few plugins and I will report them tomorrow. This is the JS console of VS code: image001 Is that what you are looking for? It does not strike as informative.

dave2k19 commented 5 years ago

My plugins:

cschlosser commented 5 years ago

Hi @dave2k19,

Thank you for your feedback. Regarding the console you were very close. Please take a look at the Console tab right to the Elements tab you screenshotted for me.

These plugins appear to be Visual Studio plugins which don't work with VS Code (at least to my knowledge). Could you please provide me with a list of VS Code plugins?

dave2k19 commented 5 years ago

Hi @christophschlosser,

thanks. Sorry I could not check back over the weekend. Not sure whether these screenshots help:

plugins_vs_code vs_code

cschlosser commented 5 years ago

Hi @dave2k19 Thank you very much! These helped me in eliminating possibilities but don't solve the problem unfortunately.

Could you please do me another favor and record a short video? Your settings.json would also be really helpful.

dave2k19 commented 5 years ago

Hi @christophschlosser, sorry for late reply again. I shot a video showing that the plugin is active and the c trigger sequence is "/**". Secondly, it shows that nothing happens after the trigger sequence is executed. https://quickfileshare.org/Unh/20190204_211735.zip

If I found the correct settings.json, it is quite slim. I searched my entire C drive. settings.json { "doxdocgen.generic.newLineAfterParams": true, "window.zoomLevel": 0 }

rowanG077 commented 5 years ago

@dave2k19

You aren't coding in Visual Studio Code. You are running Visual Studio. This plugin only works for Visual Studio Code.

jvlker commented 5 years ago

I got the same problem. Typing /** + Enter in .h or .cpp-files doesn't work. Here are my plugins: screenshot from 2019-02-04 21-26-15

And these are the only logs in the console not comming from CMakeTools after a fresh start of vscode and trying 3 times to get the doxygen-generation: screenshot from 2019-02-05 08-28-51

I use Visual Studio Code Version: 1.30.2 on an Ubuntu 16.04 VM (VirtualBox) on Win10 Host.

rowanG077 commented 5 years ago

@jvlker

Can you post a video of the issue? This has been open for weeks now and no one has posted a way to reproduce or actually shown that it doesn't work.

jvlker commented 5 years ago

doxygen

I also tried a new empty project and in a single main.cpp file it seems to work...

Here are my workspace-settings:


    "editor.fontFamily": "'Monospaced', 'Droid Sans Mono', 'monospace', monospace, 'Droid Sans Fallback'",
    "editor.fontSize": 13,
    "terminal.integrated.fontSize": 13,
    "terminal.integrated.fontFamily": "'Monospaced', 'Droid Sans Mono', 'monospace', monospace, 'Droid Sans Fallback'",
    "workbench.colorTheme": "Atom One Dark",
    "C_Cpp.configurationWarnings": "Disabled",
    "files.associations": {
        "vector": "cpp",
        "*.tcc": "cpp",
        "forward_list": "cpp",
        "list": "cpp"
    },
    "vtools.autoHideBottomBar": true,
    "vtools.autoHideSideBar": true,
    "editor.formatOnSave": true,
    "C_Cpp.clang_format_style": "file",
    "C_Cpp.clang_format_fallbackStyle": "Google",
    "search.usePCRE2": true
}
jvlker commented 5 years ago

I played a bit around with the settings and it seems, that the editor.formatOnSave is responsible. When I switch to false (and restart vscode), doxygen works. But the reformatter is more important than doxygen for me...

rowanG077 commented 5 years ago

@jvlker I can't seem to reproduce it. I installed the C/C++ Microsoft extension to use it's formatter and the plugin works for me. Would you be willing to run the plugin in debug mode together with me via screenshare or something and checking out what is going wrong?

jvlker commented 5 years ago

@rowanG077 sure, can you send me an email?

bytesoftly commented 5 years ago

Got the same problem here, any progress?

rowanG077 commented 5 years ago

@jvlker issue got resolved after restarting VS Code. @bytesoftly since you seem to be the only who still has this issue can you post a gif/movie of it not working. I can look into it on the weekend if I can reproduce it.

bytesoftly commented 5 years ago

@rowanG077 Ah same problem here, all good and awesome plugin.

MrJacquers commented 2 years ago

Facing this issue on the latest version (1.4.0). Windows 10. Latest VS Code version. TS file. Can't get the trigger sequence to work.

cschlosser commented 2 years ago

@Jacques-eMediaIT could you please open a new issue and maybe reference this one with more details and videos of your problem?

shiretu commented 2 years ago

I have same problem: typing /** with or without Enter does not trigger the generator. When I press Enter it just adds a new commented line, resulting in this overall form:

/**
* */
matiasdiaz21 commented 2 years ago

image

Same problem here. tap /** and Enter and not work

rowanG077 commented 2 years ago

Just to note this plugin only works for C/C++ not for other languages.