Tim Niemueller | 8 May 12:06 2008
Picon
Picon

Namespace not properly recognized

Hi Doxygen developers.

I have files like the following:

file.h:
namespace mynamespace {
  class MyClass {
   public:
    MyClass();
  }
}

file.cpp:
using namespace mynamespace;

/**  <at> class MyClass <file.h>
 * My fancy class.
 */

/** Constructor. */
MyClass::MyClass()
{
}

This seems to be valid C++ and compiles properly (tested with GCC 4.1
and 4.3 on Fedora 8 and 9). However, if I try to run doxygen
(doxygen-1.5.5-2.fc8) on this it will complain:
Warning: Compound mynamespace::MyClass is not documented.

What I would expect is that it collects the "using namespace" clauses
(Continue reading)

Warren Young | 9 May 04:59 2008

PATCH: Cygwin port

The following one-line change allows the current version of Doxygen to 
build on Cygwin.

--- origsrc/doxygen-1.5.5/tmake/lib/linux-g++/tmake.conf
+++ src/doxygen-1.5.5/tmake/lib/linux-g++/tmake.conf
 <at>  <at>  -42,7 +42,7  <at>  <at> 
  TMAKE_LFLAGS_SHLIB = -shared
  TMAKE_LFLAGS_SONAME    = -Wl,-soname,

-TMAKE_LIBS     =
+TMAKE_LIBS     = -liconv
  TMAKE_LIBS_X11     = -lXext -lX11 -lm
  TMAKE_LIBS_X11SM   = -lICE -lSM
  TMAKE_LIBS_QT      = -lqt

It shouldn't be applied to the top-level Doxygen sources, because 
libiconv doesn't actually exist for Linux.  (iconv() is in glibc.  It's 
separate on Cygwin because Cygwin uses a different Standard C library, 
which doesn't include iconv().)

Instead, we need a 'cygwin-g++' build configuration.  Such a thing 
already exists in the top-level tmake distribution.  It seems to be 
identical to linux-g++, currently, so essentially the same patch applies.

I don't think this patch needs to be applied to tmake itself, since not 
all tmake users will need this.  Besides, tmake seems moribund.

-------------------------------------------------------------------------
This SF.net email is sponsored by the 2008 JavaOne(SM) Conference 
Don't miss this year's exciting event. There's still time to save $100. 
(Continue reading)

SmokingRope | 10 May 02:39 2008
Picon

Embedding Doxygen Into A CMS

I want to put together a patch for allowing doxygen's html output to be embedded into a CMS. I'm testing with a very primitive php webpage; however being familiar with a few real CMS systems, my belief is that this implementation is general enough to work for most. My plan is to allow users to specify a prefix, and doxygen will generate paths which use this prefix when generating links to files. I am hoping to make something suitable for inclusion in the doxygen code base, and your thoughts would be welcome.

Goals

  • All html elements which are outside of the body tag, including the body tag itself should be removed.
  • The links which are generated currently use relative paths, however may not function properly considering a CMS frontend which includes the doxygen pages into an existing template. The link generation needs to be updated to prefix links with a customizeable link header
  • Filenames, including images, which are generally specified as relative paths need to be specified in a different way when embedded in a parent web page. A simple implementation would use the same format as above, however it is altogether possible that a different linking format could be used to allow certain files to be provided by a CMS in a more robust way (say placing the logo in a DB). It might be best to define one or more distinct prefix formats to use as replacements for non html file types.
  • It may be desirable to perform some amount of post-processing on the generated links. The major need for post-processing stems from the special semantics involved in the standard http get request, and escaping certain characters might be necessary. This feature can be postponed until the implementation is done however, and may be unnecessary.
  • Elements which i have identified as needing attention : <A>, <IMG>, <AREA>, <MAP>

Questions?

Other html elements which need consideration?

Is there any other functionality needed which i have not thought of?

Should configuration settings be in a seperate section, much like the search engine feature, or defined inline with the other HTML generator options?

Timeline

This isn't a very complicated feature, and i only expect to need a week or so to get it right. There are also a lot of templating/style features which won't be addressed, but it does seem to be a precursor to more customizable and dynamic html output.

Following this it would also be useful to update the html generator with better css names, specifically to avoid conflicts with the stylesheets of an existing CMS.

-------------------------------------------------------------------------
This SF.net email is sponsored by the 2008 JavaOne(SM) Conference 
Don't miss this year's exciting event. There's still time to save $100. 
Use priority code J8TL2D2. 
http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Jake Colman | 12 May 00:16 2008

Re: Namespace not properly recognized

>>>>> "TN" == Tim Niemueller <niemueller <at> kbsg.rwth-aachen.de> writes:

   TN> Hi Doxygen developers.
   TN> I have files like the following:

   TN> file.h:
   TN> namespace mynamespace {
   TN>   class MyClass {
   TN>    public:
   TN>     MyClass();
   TN>   }
   TN> }

   TN> file.cpp:
   TN> using namespace mynamespace;

   TN> /**  <at> class MyClass <file.h>
   TN>  * My fancy class.
   TN>  */

   TN> /** Constructor. */
   TN> MyClass::MyClass()
   TN> {
   TN> }

   TN> This seems to be valid C++ and compiles properly (tested with GCC 4.1
   TN> and 4.3 on Fedora 8 and 9). However, if I try to run doxygen
   TN> (doxygen-1.5.5-2.fc8) on this it will complain:
   TN> Warning: Compound mynamespace::MyClass is not documented.

   TN> What I would expect is that it collects the "using namespace" clauses
   TN> and prepends these namespaces to the class names to test for matching
   TN> documentation. Can someone point me to the relevant lines in the code to
   TN> have a closer look or knows a solution already?

   TN> Regards from Aachen,
   TN> 	Tim

The safest way to do this, in my opinion, is to have class documentation
immediately preceded the class declaration in the header file.  This
guarantees that Doxygen will find it correctly.  Otherwise, doing it the
way you did it with the class documentation in the .cc file, you must
fully qualify the name of the class in order for Doxygen to match the
documentation with the class.

--

-- 
Jake Colman
Director of Software Development
Principia Partners LLC
101 West Elm Street
Suite 620
Conshohocken, PA  19428
+1 (610) 755-9786
www.principiapartners.com

-------------------------------------------------------------------------
This SF.net email is sponsored by the 2008 JavaOne(SM) Conference 
Don't miss this year's exciting event. There's still time to save $100. 
Use priority code J8TL2D2. 
http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone
SmokingRope | 15 May 07:48 2008
Picon

Re: Embedding Doxygen Into A CMS

I'm about 85% finished and just want to do some testing and update the documentation before submitting a patch. Is there a way to generate the file doc/config.doc from the descriptions in 'config.l'? Or is it all just alphabetized; and organized the same way, out of coincidence?

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft 
Defy all challenges. Microsoft(R) Visual Studio 2008. 
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Behzat Erte | 15 May 13:26 2008
Picon

What about doxywizard internationalization?

Hello everyone,

Could you make internationalization for Doxywizard ?

I think goog idea :-)

Best regards,
Behzat.

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft 
Defy all challenges. Microsoft(R) Visual Studio 2008. 
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Dimitri Van Heesch | 16 May 21:18 2008
Picon

Re: Embedding Doxygen Into A CMS


On 15 mei 2008, at 07:48, SmokingRope wrote:

> I'm about 85% finished and just want to do some testing and update  
> the documentation before submitting a patch.

I'm looking forward to see what you made ;-)

> Is there a way to generate the file doc/config.doc from the  
> descriptions in 'config.l'? Or is it all just alphabetized; and  
> organized the same way, out of coincidence?

It is manually typed (and mostly indeed a copy of config.l).

Regards,
   Dimitri

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft 
Defy all challenges. Microsoft(R) Visual Studio 2008. 
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
molecule | 17 May 18:40 2008
Picon

DoxHPP : Doxygen Html Post Processor

Hello developers!

I created for my own use a little tool to move html files in
hierarchical folders, and to update hyperlinks in html pages. This
tool creates 3 folders (html, pict, template) and the only file in the
root-folder is index.html (which was my target). The software is
written in C# so it's "windows only" and you need the Microsoft DotNet
Framework 2.0, sorry for that...

The tool was written very quickly, and it may appears as very ugly
(and very simple), but I GPLed it in the hope that it will be useful
to somebody. It may not work with every Doxygen-generated html folders
because I didn't test it with other code than mine.

Sourceforge project page :
https://sourceforge.net/projects/doxhpp/

Download page :
https://sourceforge.net/project/platformdownload.php?group_id=228144

Enjoy!

molecule

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft 
Defy all challenges. Microsoft(R) Visual Studio 2008. 
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
SmokingRope | 16 May 07:31 2008
Picon

Re: Embedding Doxygen Into A CMS

Attached to this email is a patch which simplifies embedding doxygen generated documentation into a dynamic / template based website (CMS). I have attempted to update the manual where appropriate and there is a php example for doxygen's own documentation. Once you have applied the patch and compiled you can run Doxyfile_Embedded and access the complete doxygen documentation from a web browser using the provided embedded_docs.php file.

You can apply the patch using: patch -p3 -i doxygen_1_5_5_cms_embedding.patch

Please let me know if there is anything missing.

Attachment (doxygen_1_5_5_cms_embedding.patch): application/octet-stream, 87 KiB
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft 
Defy all challenges. Microsoft(R) Visual Studio 2008. 
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Zebrik.0xFF | 21 May 13:49 2008
Picon

Not everyone c++ constructions has been parsed well

Hello.
I have doxygen Version: 1.5.5 for Win32

It seems that, i can't get all reversed documentation using doxygen.

See example:

template <class T1,class T2>
class iA
{...};

template <class T>
class iB
{...};

template <class T1,class T2>
class C
  : public iA<T1,T2> //doxy error, but c++ eats
  , public iB<C<T1,T2>> //doxy error, but c++ eats
{...};

My MSVS.NET 2005 SP1 works well with it.
But doxy generate nothing about class C. Only abount .h and .cpp files 
containing it. No class diagramms, no relations.

My doxygen works well when my code looks like, but c++ reports errors:

template <class T1,class T2>
class iA
{...};

template <class T>
class iB
{...};

template <class T1,class T2>
class C
  : public iA //c++ error, but doxy eats
  , public iB //c++ error, but doxy eats
{...};

Question:
Is it doxygen bug, or i'am a dummy?

ps: sorry about my english localisation :)

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft 
Defy all challenges. Microsoft(R) Visual Studio 2008. 
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/