DoxyDoxygen icon indicating copy to clipboard operation
DoxyDoxygen copied to clipboard

Any possibility to support Atom?

Open canfoderiskii opened this issue 9 years ago • 10 comments

In Atom, there is no good doxygen plugin like DoxyDoxygen. If this plugin can support Atom, that whould be so great, but I don't know the difficulty for supporting both Sublime & Atom.

canfoderiskii avatar Apr 30 '16 14:04 canfoderiskii

Thank you. DoxyDoxygen has low dependency on SublimeText... but each editor have is own architecture plugin... and his own language for plugin.... Currently, the only external interface of this plugin are sublime text commands. But you should use "subl.exe" to call them... If a lot of people are interested in, I may write a library.... The way also address Visual Studio request...

20Tauri avatar May 01 '16 18:05 20Tauri

@20Tauri Thank you for replying me. I don't know which language is used by DoxyDoxygen. But if C/C++ is used, maybe there is not too much obstacle on the way to support Atom. Though I don't know the details of developing plugins for Atom, but i did see some plugin which is distributed with source code that is C/C++, is installed by command "node-gyp build" which internally calls Visual Studio 2013 to compile codes.

canfoderiskii avatar May 02 '16 02:05 canfoderiskii

Thank you for information Atom use Coffee, SublimeText use python to interact with editor... API seem close. The main job is API and reduce calls... Once again, If you are ready to call an executable you may consider to use "subl" and make Atom call sublime text in background...

subl -b my_file.c:1:1
subl -b --command doxy_comment_nearest_entity 
subl -b --command save

You will lost snippet functionality, but all other will work... As both DoxyDoxygen and SublimeText will be use, you have to respect their license.

Once this part will be done, and if you want snippet, We may replace"subl" by direct call to DoxyDoxygen

20Tauri avatar May 03 '16 13:05 20Tauri

@20Tauri Thank you for the reply. I don't know how to make Atom call sublime text in background, and i'm not intended to do it. I tried the command you listed in console:

subl -b my_file.c:1:1
subl -b --command doxy_comment_nearest_entity

They works fine. What i want most is the automatically generated function comment when I type in /**, so amazing.

canfoderiskii avatar May 03 '16 13:05 canfoderiskii

If you develop a plugin for Atom, it while be great to send me a link to it... Some others users may be interested in it.

20Tauri avatar May 04 '16 11:05 20Tauri

I've written a small Visual Studio Code extension that tries doing it through subl command as you explained above. Although it does work the workflow is far from ideal. Main pain points are:

  • To see changes in VSC we need to save file in Sublime and this breaks undo in VSC.
  • We need to save changes in VSC first before running commands otherwise Sublime doesn't see our new code.

Any suggestions?

ifeltsweet avatar May 12 '17 09:05 ifeltsweet

I'm not familiar with VSC API but you can probably get the current text buffer and store it in another file... Then, call sublwith that file. Then rename it (or read it back and apply the change)

Clipboard may probably use to share data too... And some plugins can add other automation features

I'm really interested in your experimentation. If a small change on the Sublime Text side may help you, let me know

20Tauri avatar May 12 '17 16:05 20Tauri

Hello, I found a plugin for VSCode, implemented with doxygen. However it has only support for a few languages (c, c ++, cpp)

In the backlog there are integrations for other languages, such as PHP. Can you help them develop support for other languages?

Ps. I'm interested in PHP support

RodrigoMagenis avatar May 03 '19 18:05 RodrigoMagenis

Hello,

I know. I have checked the existing offer on VSCode. This plugin sound great (based on a grammar). By the way even for C, C++ it look less advanced as DoxyDoxygen (for example, volatile qualifier is missing from the grammar)

I'm not currently a VSCode user, and I've a lot of projects... PHP and TypeScript are also not my mains languages... So I'm not ready to activly contribute to this project but, as you are a PHP developper, perhaps you can help them to implement the PHP grammar ?

The PHP grammar i explained in the github issue #72

20Tauri avatar May 04 '19 14:05 20Tauri

We really need doxydoxygen in atom. Please make one.

zaber04 avatar Jul 25 '19 06:07 zaber04