About Store Forum Documentation Contact
Donations:
345$/mo



Post Reply 
Header Browser Tool
Author Message
Esenthel Offline
Administrator

Post: #1
Header Browser Tool
What do you think of such a tool for easier header browsing:

It would have much easier browsing than Visual Studio:
LMB - jump to element definition
RMB - go back to previous location
Optionally hide method bodies.
Hide all "private:" stuff.
Once you move mouse cursor over element, it automatically displays the element definition in quick preview on the right (like on screen below).
Too long lines are automatically displayed in rectangle below mouse cursor (like on screen below).

I'm thinking of adding this tool instead of "Extra/API Reference.chm" doxygen file.

The tool will have also list of namespaces/classes, with realtime search and display.

(tool is of course EE based application)

Let me know your thoughts.


Attached File(s) Image(s)
   
01-01-2011 04:42 AM
Find all posts by this user Quote this message in a reply
Masterxilo Offline
Member

Post: #2
RE: Header Browser Tool
I'd prefer the comments to be above the function definitions so Visual Studio can display them in the IntelliSense popup window so I don't have to go look up any functions at all.
EDIT: Actually, this is not even your fault but M$' because it should also display comments placed after declarations. I reported this quite some time ago: http://msdn.microsoft.com/en-us/library/s0we08bk.aspx -> https://connect.microsoft.com/VisualStud...wsignin1.0

As for the tool, it's a nice idea but VS can do all of that (go to definition/definition window...).

How did you make to syntax highlighting? Custom drawing of control? Or is this supported somehow?

Btw. How did you get doxygen to parse the comments that are placed after the functions anyways? I thought you have to use "///<" for that. Maybe you have your own headers that are parsed by some tools for release versions...
(This post was last modified: 01-01-2011 04:55 AM by Masterxilo.)
01-01-2011 04:49 AM
Visit this user's website Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #3
RE: Header Browser Tool
Quote:How did you make to syntax highlighting? Custom drawing of control? Or is this supported somehow?

EE gui Text::code, with custom parsing the c++ syntax

Quote:Btw. How did you get doxygen to parse the comments that are placed after the functions anyways? I thought you have to use "///<" for that
yeah, tool that converts ee headers to doxygen compatible headers.
01-01-2011 05:06 AM
Find all posts by this user Quote this message in a reply
fatcoder Offline
Member

Post: #4
RE: Header Browser Tool
I'm pretty happy with using VS to look stuff up. Doesn't really bother me. Anyway, having this tool would just mean another window you need to have open somewhere.
01-01-2011 02:44 PM
Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #5
RE: Header Browser Tool
nobody wants it?
01-01-2011 02:58 PM
Find all posts by this user Quote this message in a reply
Harry Offline
Member

Post: #6
RE: Header Browser Tool
I'm used to browse headers in Visual and I've never use doxygen file but for me this tool would be interesting. Only disadvantage is like fatcoder wrote: you need to have opened another window (actually just like doxygen file).
(This post was last modified: 01-01-2011 03:06 PM by Harry.)
01-01-2011 03:04 PM
Visit this user's website Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #7
RE: Header Browser Tool
what about people that use doxygen file? (I personally don't use it)
01-01-2011 03:06 PM
Find all posts by this user Quote this message in a reply
Barthap Offline
Member

Post: #8
RE: Header Browser Tool
4 me header browser is not bad idea. I think users can add their own comments to classes and funcs. Best way 4 users is integration with visual studio but it is not so easy.

You can delete doxygen-generated docs. Probably nobody use it.
01-01-2011 05:17 PM
Find all posts by this user Quote this message in a reply
Masterxilo Offline
Member

Post: #9
RE: Header Browser Tool
I do use the doxygen docs. It gives a nice overview of inheriting classes and navigation to a declaration of some function or class is faster than in VS. However I wouldn't mind that much not having it.

But I would leave it in since I don't think maintaining it is too big an effort and it's almost a standard for c++ libs. Many developers are certainly even much more used to looking up up things in doxygen documentation than I am (and maybe also more used to doing this than looking for comments in headers...).
(This post was last modified: 01-02-2011 12:49 AM by Masterxilo.)
01-02-2011 12:45 AM
Visit this user's website Find all posts by this user Quote this message in a reply
Barthap Offline
Member

Post: #10
RE: Header Browser Tool
Ok, so if new tool will be very good and usefull, it'll replace doxygen docs, ok?
01-02-2011 11:06 AM
Find all posts by this user Quote this message in a reply
Harry Offline
Member

Post: #11
RE: Header Browser Tool
Maybe for some time in SDK should be doxygen and new tool together? Maybe it'll be useful even for people who use VS headers.
01-02-2011 12:40 PM
Visit this user's website Find all posts by this user Quote this message in a reply
Chris Offline
Member

Post: #12
RE: Header Browser Tool
Perhaps we could try it, then have a poll? Hard to see what its like with just pictures smile
01-02-2011 01:09 PM
Find all posts by this user Quote this message in a reply
Barthap Offline
Member

Post: #13
RE: Header Browser Tool
Esenthel, you can make alpha/beta version of tool for tests, then we'll have a poll about it.

(01-01-2011 04:42 AM)Esenthel Wrote:  Optionally hide method bodies.
(joke) Yeach, I'll never use this option, I want to see bodies of some methods, which can see only Esenthel and people with ultimate license smile
(This post was last modified: 01-02-2011 03:32 PM by Barthap.)
01-02-2011 02:21 PM
Find all posts by this user Quote this message in a reply
joacorock Offline
Member

Post: #14
RE: Header Browser Tool
I like it smile, every tool is appreciated
01-02-2011 05:57 PM
Visit this user's website Find all posts by this user Quote this message in a reply
Esenthel Offline
Administrator

Post: #15
RE: Header Browser Tool
Ok, I'll finish it! smile
01-02-2011 07:04 PM
Find all posts by this user Quote this message in a reply
Post Reply