Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I use a lot of illustrations, diagrams and equations to document C++ and python codes, and a way to do this is to inline them with doxygen. The problem is that, when coding, they are not directly available in the code (unless I use ascii-art for this purpose).
Is there an automatic, quick and fast way to, while coding, view the generated documentation? E.g., I could have a separate Eclipse tab with the rendered documented code (HTML), while coding in another tab... and the documentation rendering tab would be updating automatically as I change the code and the documentation.
Is this possible? Is there a tool, plug-in for Eclipse or add-on for Visual Studio enabling this?
Frankly, I use a second monitor (or second computer) to view such documentation just to keep them out of the way - I want to see them alongside my Visual Studio screen not taking up space that could be occupied by code.
I publish the generated Doxygen documentation to an internal web server so if you have an HTML viewer plugin you could just point it to that. (I usually have a browser open alongside).
You could setup your Doxygen project to be generating directly into the web server directory so there's no copying time to get it renewed.
One tip, if you have a large code base and Doxygen takes an annoyingly long time is to have a special setup file just pointing at the code you're working on, to quickly regenerate the relevant couple of pages. You could have a python script observing the directory and re-running Doxygen if files change.
Try my LP tool - http://code.google.com/p/nano-lp - it supports OpenOffice/LibreOffice, so you can write LP programs in WYSIWYG manner. By the way, if you decide to use markup language instead of OpenOffice, NanoLP supports several of them.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 11 months ago.
Improve this question
The main feature of Sublime Text 2 that makes it my editor of choice for programming (and anything else really) is multi-selection search and edit. It's like search-and-replace-on-steroids. Once you get used to, it's really hard to go back to not using it.
I did some research myself and couldn't find a single other editor that offers it as powerfully. Some even let you create several cursors but lack the searching bit (just found out that Notepad++ does that).
So I'd like to ask for this community's help: do you know of another programming editor that provide multi-selection search and editing in a similar level as Sublime does?
Cloud9 IDE does this.
Disclaimer: I work there.
vim seems to have support for that via plugins. See a related question on SO: Multiple selections in VIM
More recently jetBrains began adding "Sublime Text style multi selection" to their line of IDEs. I know IntelliJ and Pycharm already have it.
gedit 3 has a plugin which looks similar: http://codetree.com.au/projects/imitation/
After switching from Sublime Text 2 to gedit, I've written a plugin that's much closer to Sublime's version of multiple cursors than imitation. I've tested the plugin on versions 3.4 and 3.12. You can find it here:
https://github.com/jessecrossen/Gedit-MultiCursor
I don't think it's 100% perfect yet, so I'd be really glad to hear of any edge cases people run across so I can continue to improve it. I've also implemented something like gedit's Command-R functionality with this plugin.
Those were pretty much the only two features I missed from Sublime, but then again I don't tend to use the deep features of any editor, so as to preserve my independence ;). The quick-open functionality is not as good as Sublime's "Goto Anything", but on the other hand you get usable integration with remote file systems mounted on FUSE, gvfs or similar, whereas Sublime tends to be slow because it's recursively indexing every file.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I wanted to automate the execution of Doxygen whenever I insert my source code to my code repository. Is there any api/interface for doxygen that I can use in my java code to start its execution?
Doxygen itself is started by executing a command-line command, so you only need a way of executing a command when a check in occurs. You don't say anything about the SCC tool, Dev Environment or OS you are working with, so it's hard to give a specific answer.
The usual way to do this would be using a build server running Continuous Integration. That is, when you check in code, the build server will notice the check in, get the new code, and then execute a build (in this case of Doxygen documentation). There are many tools available that will automate a PC to make a build server. Which one to use would depend on things like the OS and Source Control package you're using. (If you don't have/want a dedicated build server you could also run a tool like this on your own PC in the background).
If you just want the build to occur on your own PC when you check in, then you could investigate your source control software to see if you can be notified of the check-in. Some SCCs may offer an ability to execute a script or command for certain events, so it may be possible to get it to execute the command for you.
Lastly, many people just set up a tool/macro within their development environment that executes Doxygen, and then they run it manually. In visual Studio (for example) you could even write a macro that would do both the Check in and execute Doxygen from a single keypress.
If you want more control with doxygen, you have to generate also xml files and create a program that analyze the xml output files to check all your constraints, and stop the build if a constaint is violated.
this technique needs some developement effort but it's the only way that i know to do what you want with doxygen.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
I'm looking for an easy-to-use, free source code comparison app for Windows, which will highlight differences side-by-side between two pieces of source code. Some apps get close to what I want, but are too restrictive by requiring you load in entire files and compare them in their entirety. Sometimes I just want to compare a section of my file, such as a single function, which may be in totally different locations in the two versions I'd be comparing, making it hard to find in both panes in large files. Basically, I'd like to be able to simply edit/copy/paste the content in both panes rather than have the restriction of using files. That way I can copy and paste one function into one pane and another into the other, editing/re-ordering as necessary.
(Note that I realize there are other comparison app recommendation threads out there, but I'm having a hard time finding a free app that isn't a strict file-to-file comparison app)
Thanks for any pointers or links, thanks!
I do this in Vim all the time. Here's what I do:
Run gvimdiff -O a b. This is Vim is GUI diff mode.
Paste "before" into left pane of Vim.
Paste "after" into right pane of Vim.
:diffupdate (not always necessary)
You can also edit either side of the diff, which can be handy.
I imagine that any text editor that supports side-by-side diff and copy and paste should be able to do something similar.
And before you object that Vim is file-based (which is true), the above procedure doesn't require creating any actual files in the file-system.
Notepad++ has a nice diff function that will suit your needs also.
Winmerge can be used to do what you outlined (i.e., edit/copy/paste snippets into two windows and then make comparisons or mergers).
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
This weekend I installed Windows 7 (brilliant!) and there I found this genious tool called Problem Steps Recorder. Apparently a tool that came with the beta bug reporting tool thingy.
I am currently trying to document some application usages for other developers. (In this exact case, how to get Showplan XML Statistics in SQL Profiler and some basic usage of Database Engine Tuning Advisor). And I was thinking that a tool like that Problem Steps Recorder with be perfect for this! Only problem is that it is only in windows 7 (?) and the output is an mht file which also contains some general bug issue text etc...
Anyways, does anyone know if this tool is available in a more general version? Or if there are some free and smooth alternatives which does kind of the same thing for Vista (and other windows versions if possible)?
Maybe Wink is your answer.
I'm looking for a better capture tool for both user documentation and reporting bugs. The best "steps recorder" that I've seen is bundled with Testuff. Their Test Runner app lets you select a region to record (video). It captures every mouse click and logs every key press along side the video playback. Of course, it's designed only for reporting bugs to a development team.
I'm still using SnagIt (cheap, not free) for capturing screens and adding annotations. I also have Camtasia, but that's definitely not "free" as you requested :)
I just stumbled upon 'Imago recorder', available via various software / download sites. It's not pretty but it does the trick and it's free.
It's currentyl available here
Additional option you should definitely pay attention to is StepsToReproduce. There are several options for recording (screen/window/region) and nice powerful annotation tools. And it's also free!
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I have inherited over 600 files of ColdFusion source code running a internal web site for my company. One of my tasks is to "document" it. The code base represents about 5 years of development and there is no technical specification of what it does.
The developers have maintained a change log of each file and there is a consistent header.
My thought is that I can build a dependency map of the various modules and referenced stored procedures to facilitate this documentation by scanning the source files. I have used Doxygen in the past for c++ source code and am wondering if a tool like this exists for ColdFusion.
One output I am investigating is the ability to create a xmind file as means of visualizing the cross dependencies in module inter-relationships.
Thanks in advance,
Chris
The ColdFusion server has built in introspection that outputs javadoc like documentation for any CFC class.
See: http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm
However, it requires an RDS login/password for your server. For delivery to third parties, I set up a recursive script that does a cfhttp fetch against the docs for each cfc file, and then compiles the pages to PDF with cfdocument.
You could start with ColdDoc
Also, heres a UML 2 CFC generator.
I guess what you really need is something to reverse engineer the coldfusion code into uml class diagrams. I don't know of anything off the top of my head.
MagicDraw, Objecteering don't seem to do it yet.
After trying to find an answer to this question myself I ended up writing this solution:
ColdDuck
Maybe it is too late for you now but I am just spreading the word.
Murray
Sounds to me like creating your own Xmind or XMI file is the way to go. The XMI file may be more portable between tools, but the last time I looked at doing that the XMI file formats were a bit daunting for the time I had available to work on the solution. If the formatting of the headers consistent is enough to read with ReFind or Find I'd build a script that uses cfdirectory and cffile to walk the code tree and output the file(s).