I normally use a program call Doxygen to document my source
code.( http://www.stack.nl/~dimitri/doxygen)
This method works great for small and medium size projects, and you can
get good documentation like the following: http://axter.com/smartptr
Now I'm on a client site, and I'm trying to create the same type of
documentation on a very large project.
I ran the Doxygen program, and it ran for over 16 hours, before I had
to kill it.
Before I look into a different solution, I wanted to see if anyone else
has had the same problem in the past, and what type of solution was
used to document the source code for a large project (suite) that has
over 11,000 source files.
Sorry if OT
----------------------------------------------------------------------------------------
David Maisonave http://axter.com
Top ten member of C++ Expert Exchange: http://www.experts-exchange.com/Cplusplus
---------------------------------------------------------------------------------------- 8 5129
Axter wrote: I normally use a program call Doxygen to document my source code.(http://www.stack.nl/~dimitri/doxygen)
This method works great for small and medium size projects, and you can get good documentation like the following: http://axter.com/smartptr
Now I'm on a client site, and I'm trying to create the same type of documentation on a very large project. I ran the Doxygen program, and it ran for over 16 hours, before I had to kill it.
Before I look into a different solution, I wanted to see if anyone else has had the same problem in the past, and what type of solution was used to document the source code for a large project (suite) that has over 11,000 source files.
No, I haven't.
I would think that a large project like that would be split into
several, distinct pieces that could be documented independently. I
know, many such projects are not and are just big monstrosities that
got out of hand....maybe it is time for some refactoring.
Axter wrote: I normally use a program call Doxygen to document my source code.(http://www.stack.nl/~dimitri/doxygen)
This method works great for small and medium size projects, and you can get good documentation like the following: http://axter.com/smartptr
Now I'm on a client site, and I'm trying to create the same type of documentation on a very large project. I ran the Doxygen program, and it ran for over 16 hours, before I had to kill it.
Before I look into a different solution, I wanted to see if anyone else has had the same problem in the past, and what type of solution was used to document the source code for a large project (suite) that has over 11,000 source files.
I'd like to point out that Xerces-C, the XML parser from Apache, uses
Doxygen for its documentation. I don't believe it's on the order of 11K
source files, though.
Noah Roberts wrote: Axter wrote: I normally use a program call Doxygen to document my source code.(http://www.stack.nl/~dimitri/doxygen)
This method works great for small and medium size projects, and you can get good documentation like the following: http://axter.com/smartptr
Now I'm on a client site, and I'm trying to create the same type of documentation on a very large project. I ran the Doxygen program, and it ran for over 16 hours, before I had to kill it.
Before I look into a different solution, I wanted to see if anyone else has had the same problem in the past, and what type of solution was used to document the source code for a large project (suite) that has over 11,000 source files.
No, I haven't.
I would think that a large project like that would be split into several, distinct pieces that could be documented independently. I know, many such projects are not and are just big monstrosities that got out of hand....maybe it is time for some refactoring.
I'm trying to avoid creating an independent help file for each sub
project, because I would have to create over 300 help documents, and
IMHO, its usage wouldn't be practical.
I want to create one help document for the entire suite, so I'm trying
to run doxygen from the main tree.
The main tree is broken down into three sections:
SrcClient (162-projects)
Common (94-projects)
SrcServer (109-projects)
I guess my other alternative is to try to document the three sections
independently, but that will still give me about 3900 source files per
section.
And I think Doxygen would still have a hard time processing that many
files.
I've had two other clients which also had suites of this size, and
they also lacked source code documentation.
I would think someone by know would have already come up with a
solution to document such monster suites.
Axter wrote: Noah Roberts wrote: Axter wrote: I normally use a program call Doxygen to document my source code.(http://www.stack.nl/~dimitri/doxygen)
This method works great for small and medium size projects, and you can get good documentation like the following: http://axter.com/smartptr
Now I'm on a client site, and I'm trying to create the same type of documentation on a very large project. I ran the Doxygen program, and it ran for over 16 hours, before I had to kill it.
Before I look into a different solution, I wanted to see if anyone else has had the same problem in the past, and what type of solution was used to document the source code for a large project (suite) that has over 11,000 source files.
No, I haven't.
I would think that a large project like that would be split into several, distinct pieces that could be documented independently. I know, many such projects are not and are just big monstrosities that got out of hand....maybe it is time for some refactoring.
I'm trying to avoid creating an independent help file for each sub project, because I would have to create over 300 help documents, and IMHO, its usage wouldn't be practical. I want to create one help document for the entire suite, so I'm trying to run doxygen from the main tree. The main tree is broken down into three sections: SrcClient (162-projects) Common (94-projects) SrcServer (109-projects)
If the package separation is decent you should only need to document
the three sections independantly for the developers working on them and
then the public interface used by others. Much easier to view
documentation that way that to have one large monolithic thing you have
to hunt through. This method works great for small and medium size projects, and you can get good documentation like the following: http://axter.com/smartptr
Very interesting.
I didn't realize there was that many smart pointers. reference
counted smart/ versus just _smart_ versus etc..
ma740988 wrote: I didn't realize there was that many smart pointers. reference counted smart/ versus just _smart_ versus etc..
Hmm...
- pointers which cannot be used inside containers
- auto_ptr - essentially the weakest possible smart pointer
- pointers which share, and which can be used inside containers
- reference counting smart pointers
- RCSPs that store their count in their target objects
- RCSPs that use virtual AddRef() and Release() methods
- RCSPs that store their count in a new int
Thence, smart pointers that can survive cycles, possibly using Garbage
Collection techniques.
Thence, smart pointers that can inform all their clients when one client
decides to kill the target item, and all other clients must be informed.
Thence, smart pointers that may contain arrays returned by new[].
Did I miss any?
--
Phlip http://www.greencheese.org/ZeekLand <-- NOT a blog!!!
Phlip wrote: ma740988 wrote:
I didn't realize there was that many smart pointers. reference counted smart/ versus just _smart_ versus etc..
Hmm...
- pointers which cannot be used inside containers - auto_ptr - essentially the weakest possible smart pointer - pointers which share, and which can be used inside containers - reference counting smart pointers - RCSPs that store their count in their target objects - RCSPs that use virtual AddRef() and Release() methods - RCSPs that store their count in a new int
Thence, smart pointers that can survive cycles, possibly using Garbage Collection techniques.
Thence, smart pointers that can inform all their clients when one client decides to kill the target item, and all other clients must be informed.
Thence, smart pointers that may contain arrays returned by new[].
Did I miss any?
Yes many. :-)
I notice you're referring to all the reference smart pointers as
reference counting.
However, that is just one type of reference smart pointer.
Reference smart pointers that store the count in the target object are
normally called reference intrusive smart pointers, and they may or may
not use a count method.
Reference link smart pointers don't use a reference count at all.
Clone smart pointers (deep-copy) don't share the pointer, and perform a
deep copy when passed by value.
The following smart pointer also has a COW smart pointer policy by
default: http://axter.com/smartptr
This COW smart pointer is a mix between a shared smart pointer and a
clone smart pointer.
You can also have a synchronized smart pointer. http://axter.com/smartptr/structintr...ck__policy.htm
Using the above policy you lock the smart pointer and the pointee at
the same time, so you can safely use the pointee in a multithread
environment.
You can have smart pointers with value semantic for comparison
operator, which would allow you to use the smart pointer in a sorted
container. http://axter.com/smartptr/structvalu...ic__policy.htm
And much more...
You can create over 250 different types of smart pointers just using
the default policies that are included in this smart pointer.
And boost has a few more http://www.boost.org/libs/smart_ptr/smart_ptr.htm
----------------------------------------------------------------------------------------
David Maisonave http://axter.com
Top ten member of C++ Expert Exchange: http://www.experts-exchange.com/Cplusplus
----------------------------------------------------------------------------------------
Phlip <ph*******@gmai l.com> writes: - pointers which cannot be used inside containers - auto_ptr - essentially the weakest possible smart pointer - pointers which share, and which can be used inside containers - reference counting smart pointers - RCSPs that store their count in their target objects - RCSPs that use virtual AddRef() and Release() methods - RCSPs that store their count in a new int
Thence, smart pointers that can survive cycles, possibly using Garbage Collection techniques.
Thence, smart pointers that can inform all their clients when one client decides to kill the target item, and all other clients must be informed.
Thence, smart pointers that may contain arrays returned by new[].
Did I miss any?
Yes. What about those that won't do any resource management, but they are
smart in some other way? E.g., locking proxies.
ImRe This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics |
by: Michael Foord |
last post by:
I'd like to formalise slightly the license I release my projects
under. At the moment it's 'free to use, modify, distribute and
relicense'. This is basically fine as I don't want t oprevent people
using my work in commercial settings - but I would like to retain the
right to be identified as the author. I'd also like to prevent people
selling derivative works where my stuff forms the substantial part of
the poduct.
I'd prefer to use an...
|
by: TheAd |
last post by:
At this moment I use MsAccess and i can build about every databound
application i want. Who knows about a serious open source alternative?
Because Windows will be a client platform for some time, i prefer a
solution that (also) supports Windows.
On the net I found a number of products that i looked at, but none of
them gave me the impression of a serious candidate at this moment
(KNoda, Gnome DB Manager, InterBase...).
2 additional...
|
by: kj |
last post by:
I consider myself quite proficient in C and a few other programming
languages, but I have never succeeded in understanding a largish
program (such as zsh or ncurses) at the source level. Basically,
I quickly become disoriented, losing sight of the forest for the
trees.
What's your approach for understanding a large program at the source
level? By "understanding a program" I mean more than just figuring
out where to zero in to make a...
|
by: GTi |
last post by:
Is there any source code documentation tools available for Visual
Studio 2005 ?
I have created a LIB that must be documented. Must I do it by hand or
is it
some kind of tools to pre document my source code?
|
by: Giovanni Bajo |
last post by:
Hello,
I just read this mail by Brett Cannon:
http://mail.python.org/pipermail/python-dev/2006-October/069139.html
where the "PSF infrastracture committee", after weeks of evaluation, recommends
using a non open source tracker (called JIRA - never heard before of course)
for Python itself.
Does this smell "Bitkeeper fiasco" to anyone else than me?
--
| |
by: smachin1000 |
last post by:
Hi All,
Does anyone know of a tool that can automatically analyze C source to
remove unused #includes?
Thanks,
Sean
|
by: bharathreddy |
last post by:
This Article gives an introduction to VSTS Team Foundation & fundamental difference between Visual Source Safe (VSS) and VSTS Team Foundation.
Team Foundation is a set of tools and technologies that enable a team to collaborate and coordinate a project (software or non software projects). The team collaboration is achieved by several tools and features available as part of "Team Foundation".
Team Foundation Server
The Team...
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look !
Part I. Meaning of...
|
by: Hystou |
last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it.
First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
|
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth.
The Art of Business Website Design
Your website is...
|
by: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
| |
by: isladogs |
last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM).
In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules.
He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms.
Adolph will...
|
by: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one.
At the time of converting from word file to html my equations which are in the word document file was convert into image.
Globals.ThisAddIn.Application.ActiveDocument.Select();...
|
by: TSSRALBI |
last post by:
Hello
I'm a network technician in training and I need your help.
I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs.
The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols.
I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
|
by: adsilva |
last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
|
by: 6302768590 |
last post by:
Hai team
i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
| |