I have one source file which describes interface of a class with many doxygen comments.
Maybe with doxygen it can be generated to a html that can be easily read and with handly cross-references, but I don't want to install a huge doxygen to my system just for viewing this file (in my Ubuntu it seems doxygen requires ~1GB disk space!).
Is there any quick/simple way to view doxygen commented file?
I suggest to try the Linux binaries (or sources) from the official doxygen site (http://www.doxygen.org/download.html#srcbin). Then you are done with only 11.1MB of download (and maybe 50MB of disk space).
Ubuntu seems to make doxygen depend on all possible packages (including LaTeX) but these are mostly optional, and not needed for HTML output...
If your using the Emacs text editor, you can install the highlight-doxygen package, it will highlight doxygen comments to that they will become much easier to read.
If you have the doxygen within the package, you still don't get something you can look at.
The answer to the question I had when I got here was to run
doxygen -g
and then
doxygen
to produce html files in the html directory. The first produces the configName (default) and the second produces the html using the (default) cofiguration file.
Related
Where does VSCode store its Most Recently Used (MRU) list of .NET projects and solutions on Windows?
And also is there some open source code to fetch VSCode's MRUs?
I scanned all files in this dir (recursive) C:\Users\pat\AppData\Roaming\Code with no luck
For you it should be in C:\Users\pat\AppData\Roaming\Code\User\globalStorage\state.vscdb; this file is an SQLite database and you can look around for tools that open this kind of file (because it won't be readable as plain text) to see what's inside and decide whether you can sync it across machines (if that's what you're after).
Also reference this answer, there's very useful stuff over there.
Edit: Thanks this is indeed the file I was looking for.
It can be read with the tool SQLitebrowser.
I didn't easily found a .NET library to read the state.vscdb file + we are very reluctant in embedding a whole library in our product for a small feature.
Hopefully state.vscdb contains the MRU file list in clear textual JSON.
So what I did is just open this file as text, and locate the JSON and read it. Clearly it is ugly but JSON shouldn't be crypted anytime soon in such file and if it fails one day, this feature is not critical for us, just a convenient helper for the user.
The JSON to locate looks like:
{"entries":[
{"fileUri":"file:///c%3A/Dir/treeItem.ts"},
{"fileUri":"file:///c%3A/Dir/YourSolution.sln"},
...
I'm trying to find the interfile (i.e. which files include which other files) dependencies in a project using doxygen. Tbh, all I want is some pictures summarising that, but it doesn't seem to be possible to get just that.
My relevant settings are:
Wizard:
Output - only HTML
Diagrams - use dot tool from GraphViz (which is installed). Only Include dependency graphs is selected.
Expert:
Have dot: yes
INCLUDE_GRAPH: yes
DIRECTORY_GRAPH: yes (I can't find this either)
DOT_PATH: /usr/local/bin (dot is definitely found here)
Running this goes to completion, but no new images are produced. Not to be deterred, I visit index.html, but I see no way to see the include graphs. Where are they supposed to be?
Using the GUI wizard, on OS X 10.13.6
If your files are not "Documented enteties" you have to change "Select the desired extraction mode" from "Documented entities only" to "All Entities".
Using the Doxygen GUI 1.8.17, this can be found under Wizard->Mode->All Entities
I think this is the same as changing EXTRACT_ALL option from NO to YES.
Is there a way to configure emacs so that whenever I open a file under a certain path it will automatically search (and in case load) a TAGS file in a part of the path? So for instance when opening
/usr/src/foo/baz/bar.c.It will load
/usr/src/foo/TAGS file?
I'd suggest you going through this wiki. There is a good example of doing the same with etags (Auto refresh of the tags file) (which I won't post here), but hopefully it's no so hard to make it work for ctags.
Check out this package http://www.emacswiki.org/emacs/EtagsTable It's available on MELPA and does exactly what you want.
http://blog.binchen.org/posts/how-to-use-ctags-in-emacs-effectively-3.html
The point is in this case, a little bit elisp code is more versatile, I've been using this solution for two years.
I've been using an application called "WinMerge" lately for document comparisons, but one of the requirements of my teams script files (for auditing purposes) is that when we release a revision of a script we highlight the changes in red (RTF format I believe, it's through Lotus Notes) To that end, is there any software that can automatically highlight changes for me or is the best I'm going to get a list of differences and be expected to manually highlight all changes?
Assuming an HTML+CSS solution meets your needs, this article from Linux Journal shows a shell script that reads diff output and writes an HTML document with colored text highlighting the differences.
On Windows, it would probably work as-is under bash as provided in the MSYS environment from the MinGW folk or in bash from Cygwin. The script itself isn't too large, I would imagine it could be ported to Perl with only a moderate effort.
Since converting HTML to RTF turns out not to have a trivial solution that I've found, you might have better luck porting the script to directly output RTF.
If an HTML report is acceptable, Beyond Compare can generate a comparison report that highlights differences. You can use the built-in stylesheets or a custom internal one to style the differences in red (the default is a light red color already).
It doesn't seem to be able to generate RTF, but perhaps there is a simple conversion between html/css and rtf.
Within the Netbeans 6.5's Tools -> Options -> Fonts & Colors -> Syntax dialog, you have the ability to change the look and feel of the Netbeans text editor. When you select a language, you are presented with a preview of your font/color scheme. However, when I preview Java, there are far more options for syntax changes than are being displayed in that preview window. If I were able to view a more robust piece of code, I'd be able to see the immediate effect of more of the options.
How can I supply a preview document to view my font/color changes?
UPDATE:
After looking into this some more, I've been able to narrow down the problem a bit. From what I can tell, everything in Netbeans is considered a plugin. The GUI editor is a plugin, and even the text editor is a plugin. This means that what ever piece of Netbeans that actually analyzes Java code and does syntax highlights is also a plugin (since Java is just one of many languages Netbeans highlights, it makes sense this is a plugin).
I think fromvega is on the right track with his suggestion. The tutorial for creating a manifest file editing plugin pointed me in the right direction. The tutorial eludes to a file used as a sample document used for font/color previews. It tells you how to create one inside this new plugin project. (Located in "Registering the Options in the NetBeans System Filesystem", part 4. About 4/5 of the way down the page.)
My next line of thought was to look for the Java syntax editing mode plugin and find this file and update it with a richer example file. I looked in the installation directory and came up empty, but I found what looks like the appropriate files within my user settings directory. There is a config directory with a lot of subfolders within my user directory (Windows: C:\Documents and Settings\saterus.netbeans\config).
I've been poking around inside this directory a bit, but have only found the xml files the manifest tutorial talks about. I have been unable to find the extensionless sample file for the Java plugin that I believe should be there.
Since I've hit a brick wall for the moment, I thought I'd toss it back to the SO community and see if you guys might make the last leap and find the solution.
Just for anyone who wants to alter this themselves it is possible on a unix machine to use grep to locate the file i.e.
grep -lr "some part of the current sample code" /path/to/netbeans
I used this method to locate the ruby example filename and from that identified that it is kept in org-netbeans-modules-ruby.jar as a file called RubyExample. By simply altering that file I was able to construct a better sample file for my own use.
Hope this helps someone!
The document which is displayed (for each mime type) is specified in a particular folder in the "system file system" (which is a NetBeans concept which is a virtual file system composed from contributions from individual modules; this is how functionality is dynamically registered in NetBeans).
Modules typically specify their system file system contributions in a file named "layer.xml" in the plugin. The create plugin templates typically offer to create this for you.
For example, here's how the Python example is registered:
<filesystem>
...
<folder name="OptionsDialog">
<folder name="PreviewExamples">
<folder name="text">
<file name="x-python" url="PythonExample.py"/>
</folder>
</folder>
...
Here, PythonExample.py is a sample file in the same directory as the layer file.
Therefore, what you need to do is create a plugin which overrides the existing registration(s) for the mime type(s) you care about and provide alternate sample documents. You may need to hide the existing registration first (see the _hidden
part from http://doc.javanb.com/netbeans-api-javadoc-5-0-0/org-openide-filesystems/org/openide/filesystems/MultiFileSystem.html ).
Hopefully this guides you in the right direction.
However, in thinking about it, we probably ought to make the preview area editable - so people can cut & paste whatever codefragment they care about right in there. This wouldn't be persistent, so whenever you change languages you get the original samples back - but it provides a quick way to see your own code. This shouldn't be just for the Fonts & Colors customization, but for the Formatting preview panels as well.
I've filed an issue against NetBeans for this:
http://www.netbeans.org/issues/show_bug.cgi?id=155964
-- Tor
I think you can only accomplish that with a new plugin, since you need somekind of parsing to define what is what.
Give a look a these tutorials, I haven't read them in details but they seem to show you how to do what you want:
http://platform.netbeans.org/tutorials/nbm-mfsyntax.html
http://www.antonioshome.net/kitchen/netbeans/nbms-coloring.php