Question

Hi,

I'm trying to use your plugin , but in regards to the official online documentation on that the section describing the dxygenplugin global settings is really incomprehensible to me...

1) The minimal settings should look like these ? Set PROJECT = Set DOCS_BASE_ = Set URL_BASE_ =

where: is the name of the project (and should be present in the name of the other 2 variables, that is DOCS_BASE_ and URL_BASE_) is doxygen's subdirectory inside the home-directory in which doxygen stores its output is the url corresponding to

For example: I wanna create a link to "myClass" within the project "myProject", this is the settings: Set PROJECT = myProject Set DOCS_BASE_myProject = /home/whatever/doc/doxydoc/myProject/html/class Set URL_BASE_myProject = http://www.whatever.com/doc/doxydoc/myProject/html/

and then I can link the given class by inserting %DOX{myClass project="myProject"}%

2) Then u say something like: Set SHORTDESCRIPTION = Creates links to doxygen-generated docs using %DOX{classname}%. Set DEBUG = 0 And before "To reference a plugin setting write %_%, i.e. %DOXYGENPLUGIN_SHORTDESCRIPTION%": %_%, i.e. %DOXYGENPLUGIN_SHORTDESCRIPTION%

Does that mean that in order to reference the variable DEBUG i should write something like: %DOXYGENPLUGIN_DEBUG% ?

3) According to doxygen settings, it's also possible to set CREATE_SUBDIR yes so that doxygen dynamically generates 2-level subdirectories in which storing the output. Can your plugin identify the page where a given class is stored if CREATE_SUBDIR is set to yes without me including the dynamically generated subdirs in both and ?

For example, suppose that: 1) CREATE_SUBDIR = YES 2) Therefore the full path and url of the classe is something like:

path

/home/whatever/doc/doxydoc/myProject/html/class/d6/d5d/myClass.html

url

http://www.whatever.com/doc/doxydoc/myProject/html/class/d6/d5d/myClass.html where the substring "/d6/d5d/" corresponds to the subdirectories dyinamically generated by doxygen

3) the doxygen settings are exactly like the ones at the point (1) Now, would the link generated %DOX{myClass project="myProject"}% work fine? If not, how can I do for using your plugin in the case doxygen CREATE_SUBDIR is on ?

I really need to get your kind feedback!!!

THANKS a LOT in advance

Environment

-- AshkanVedaee - 30 Jun 2008

Answer

Sorry, closing this after more than 30 days of inactivity. Please feel free to re-open if needed.

-- PeterThoeny - 02 Aug 2008

Change status to: AskedQuestions AssignedQuestions AnsweredQuestions ClosedUnanswered