headers
Steve Goodrich | 23 May 22:13
Favicon

More documentation on \example?

I'm new to doxygen (everyone has to start sometime, right?) and I've got a
question about the use of the \example tag.

I have a java source file with this in it:
	/**
	 * \brief	Determine if the API call has been canceled.
	 * 	
	 * \return 	true if the API call was canceled, false if the API
call was not canceled.
	 */
	public boolean canceled() {
		return isCanceled;
	}
	/**
	 * \example edkresult_canceled_example.js
	 * Some info about the canceled example.
	 */

The file edkresult_canceled_example.js has an example of using the
"canceled" method:
	// edkresult_canceled_example.js
	function main() {
	     var output = "API Test\n";
	     var API = new MyApi();                // instantiate the API
	     if (API != null) {                    // if we have a valid API
instance, make our calls
	         var version = API.getVersion();   // get the result of the
API call
	         output += "The API call " + (version.canceled() : "was" :
"was not") + " canceled.\n";
(Continue reading)

Permalink | Reply | 0 comments |
headers
Lefteris Karapetsas | 23 May 05:05
Picon
Favicon
Gravatar

Creating a @subpage connection without actually generating a link

Hello all,

I have a question to the group, related to my previous question but this time regarding only <at> subpage. I have the same setup I presented in my previous email but I also want the included htmls which come from generated pages to be a subpage to this main doc page. <at> subpage would work nicely except I don't want the link to appear the way all other links appear in the documentation nor do I want it to appear where I write the <at> subpage command. Is there any option to create the <at> subpage link between two pages but without actually having the link appear? What I am using now is a hidden div to achieve it. Any other more doxygen-ish way exists?

Here is what I do:

/**
**
** <div style="display:none;">
** <at> subpage ExampleTopic1PGE
** <at> subpage ExampleTopic2PGE
** </div>

**<!-- more stuff above -->

** <at> docsubsection{3.1 ExampleTopic_1}
** <at> docsubpage{ExampleTopic1PGE}

** <at> htmlinclude Doxygen_Html/ExampleTopic1PGE.html

**

** <at> docsubsection{3.2 Example Topic 2}
** <at> docsubpage{ExampleTopic2PGE}

** <at> htmlinclude Doxygen_Html/ExampleTopic2PGE.html

** <!-- more stuff below -->
**/

As you can see the subpage link is created inside the hidden div so the link does not appear. Later I have my own styled link which is basically just an anchor which I invoke with the ALIAS <at> docsubpage to go to the subpage itself.


What this generates is like this:

3.1 Example Topic
<link to own page>  <--- here you can click to go to a single page that contains only the information of this topic
<contents of the page included by <at> htmlinclude>

Thank you for your time,
   -Lefteris
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Permalink | Reply | 0 comments |
headers
Jake Colman | 22 May 14:44

Markup For Tables - No Header Row


I'd like to use the Markup technique for creating a table but I need a
table without a header (my table is several rows/columns of values and
the header would meaningless).  Looking at the commands it looks like it
insists on treating the first row in a special way.  Is there a way
around this?

--

-- 
Jake Colman | Director, Software Development
Principia Partners LLC
101 West Elm Street | Conshohocken | PA 19428 | +1 (610) 755 9770
t: +1 (610) 755 9786 | c: +1 (610) 348 2788 | f: +1 (201) 221 8929
e: colman <at> ppllc.com | w: www.principiapartners.com
Credit technology innovation awards winner 2008, 2009 & 2010

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 3 comments |
headers
Stefan Ludewig | 21 May 16:23
Favicon
Gravatar

@subpage not working properly, if a page and a section of another page have the same name

Hi all.

 

I have a setup like this:

 

/**

<at> mainpage Name

<at> subpage Foo

<at> subpage FooBar

*/

 

/**

<at> page Foo Foo

Some text

<at> subpage Bar

*/

 

/**

<at> page Bar Bar

Some text

*/

 

/**

<at> page FooBar

Some text

<at> section Bar

Some more text

*/

 

If I generate a doxygen html-docs from this setup, then the subpage link on page Foo links to FooBar’s section Bar instead of to page Bar. However, the link in the treeview correctly links to page Bar.

 

Is this a known bug with known workarounds od do I really have to assure, that all pages, sections, subsections and subsubsections in a project have unique names (which could be quite problematic when generating a doc from multiple projects from different devs)?

 

Thanks,

Stefan.

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Permalink | Reply | 1 comment |
headers
Lefteris Karapetsas | 20 May 18:23
Picon
Favicon
Gravatar

Tableofcontents and copydocing a page

Hello all,

I have two different and quick questions.

Question 1: Using \tableofcontents I am trying to organize the main documentation page of my library but it seems that the indentation of the list gets destroyed after encountering the first <at> subsubsection. In particular all the <at> sections afterwards go to the <at> subsection level. When I checked the \tableofcontents documentation it mentioned only that it works for up to subsections and no more. So I guess this is why this occurs. How can I document a table of contents for more indentation levels? Anyone else aware of this issue? Any way to solve it? I might be forced to:
a) either do the ToC manually
b) Have all indentation in the page from <at> subsubsection and down with a different custom html tag so that doxygen won't see it and the ToC won't get screwed. Of course that means that the ToC will have only two indentation levels which beats the whole purpose I guess.


Question 2: I have a <at> page (not the <at> mainpage) which is the biggest documentation page of my library. In there I include other <at> page(s) with the <at> subpage command. All the <at> subpage command is create a link. In some occasions this is nice, but what if I want to actually include the whole
other page inside this page? Is there any command to achieve it? I tried <at> copydoc but it did not work. It only include the plain text before the first <at> section of the <at> page I attempted to include.

Thanks for your time!

-Lefteris
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Permalink | Reply | 4 comments |
headers
Albert | 20 May 13:20
Picon

Opening new tab for svg image through "arrow out"

Dear All,

In the new release there has been a change in respect to handling svg images:
> + CHG: For interactive SVGs the print button has been replaced by a
>       "arrow out" button that opens the original non-interactive SVG in a
>       new window.

When I click on Windows, using the latest version of Firefox, on the
arrow a new, empty tab is opened, and I get the message:

  Firefox doesn't know how to open this address, as the protocol(d)
isn't associated with any program.

When doing the same in the Internet Explorer a new tab is opened and
the svg image is shown.

(When doing the same in the older version (printer icon) I got similar
messages, but I never used it.)

Any suggestions ?

Albert

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 8 comments |
headers
Dimitri van Heesch | 19 May 14:22
Picon
Favicon

Doxygen-1.8.1 in SVN

Hi,

Version 1.8.1 has been released. Here is the changelog since the last SVN 
update:
------------------------------------------------------------------------------
+ BUG: id 674583: Fortran: continuation by ampersand not placed in code output.
+ ADD: A -- will now be rendered as an 'en dash', similar --- will produce an
       mdash.
+ BUG: id 673870: Added C++11 classes when BUILTIN_STL_SUPPORT is enabled.
+ CHG: Added natural scrolling for tablet devices (like the iPad)
       when using the treeview.
+ BUG: id 673983: Using a backslash in a section cause 026E30F to appear in the
       latex TOC.
+ BUG: id 675757: Fixed indenting issue after the end of a markdown code block
       inside a list.
+ BUG: id 523156: Fortran: Prefix of routines got stripped.
+ BUG: id 676294: Fixed LaTeX error when backslash appeared in a hyperlinked
       code fragment.
+ BUG: id 671166: Fortran: Fixed problem causing call/caller graphs not to be
       generated.
+ ADD: id 676116: Use new index style for page index.
+ CHG: Changed the look of the source code output.
+ CHG: For interactive SVGs the print button has been replaced by a
       "arrow out" button that opens the original non-interactive SVG in a
       new window.
------------------------------------------------------------------------------
Enjoy,
  Dimitri

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 0 comments |
headers
Jasdeep Saini | 19 May 04:54
Picon

Hiding the Main Page

I was wondering if there is any way to hide the main page.  I have tried setting the visible property for the
mainpage in the DoxygenLayout.xml to no, but the main page navigation tab always shows up.

Thanks in advance for your help,

Deep
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 0 comments |
headers
Jake Colman | 17 May 14:15

Help Linking to External Documentation


I am trying to figure out how to use Tag Files to link to external
documentation that is available for the third party libraries that I am
using, specifically Qt and Roguewave SourcePro.  For both libraries I
have access to their source code.  Both libraries also provide
beautiful documentation on their respective web sites.  In Roguwave's
case I'm almost certain it was produced by some version of Doxygen.

What is the recommended way to include Roguwave's and Qt's documentation
in to my own documentation so that I process Roguwave and Qt only once?
Do I have to first run Doxygen against the third-party source code?
Doxygen's manual seems to imply that you can link to external
documentation even if you do not have the original source code?  Also,
if I have to process the source code, what is the value of the URL
option to the tag file?

Can someone please point me to the correct approach for getting Roguwave
and Qt to link with my own documentation?

Thanks.

...Jake

--

-- 
Jake Colman | Director, Software Development
Principia Partners LLC
101 West Elm Street | Conshohocken | PA 19428 | +1 (610) 755 9770
t: +1 (610) 755 9786 | c: +1 (610) 348 2788 | f: +1 (201) 221 8929
e: colman <at> ppllc.com | w: www.principiapartners.com
Credit technology innovation awards winner 2008, 2009 & 2010

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 5 comments |
headers
Venkatesh U | 17 May 00:46
Picon
Gravatar

unable to use \triangledown in latex.

Hi,
 I am not able to use the symbol \triangledown which are part of
amssymb package in  latex. Document generation fails. It is possible
to specify which packages to use in doxygen?

Thanks,
Venkatesh

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 1 comment |
headers
BenG | 11 May 12:23

Cryptic Warning Message


Normally warnings are generated using the (default) setting "$file:$line:
$text", and this normally gives a message in the format:

C:\display.c:1768: warning: parameters of member print are not (all)
documented

However I'm getting one warning that I can't resolve:

<@6>:1: warning: parameters of member @6 are not (all) documented

I can't find any way of detecting which line, function, variable etc.. that
is causing the above warning.
Any suggestions?
--

-- 
View this message in context: http://old.nabble.com/Cryptic-Warning-Message-tp33776023p33776023.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Permalink | Reply | 0 comments |

Gmane