473,396 Members | 1,914 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,396 software developers and data experts.

Doxygen Mainpage-like tag for XML comments

I have looked through the docs for the XML documentation tags in the
C# Programmer's Reference, and I haven't come across a "MAINPAGE" tag
like you find in Doxygen. This tag is nice for when you want to give
the reader a broad overview of your software architecture and then
give them links to the main software blocks. Does anyone have any
experience creating main pages using the C# XML documenter?

--Bob
Nov 15 '05 #1
3 4475
If you use NDoc you can link your own HTML files into the finished CHM at
compile time.
--
____________________
Klaus H. Probst, MVP
http://www.vbbox.com/

"Bob Johnson" <bo*********@fastmail.fm> wrote in message
news:ec*************************@posting.google.co m...
I have looked through the docs for the XML documentation tags in the
C# Programmer's Reference, and I haven't come across a "MAINPAGE" tag
like you find in Doxygen. This tag is nice for when you want to give
the reader a broad overview of your software architecture and then
give them links to the main software blocks. Does anyone have any
experience creating main pages using the C# XML documenter?

--Bob

Nov 15 '05 #2
Can I create links back to the NDoc documentation inside my external
HTML files? The scenario here would be to write a class name in the
external HTML and have NDoc create a link to that class'
documentation.
"Klaus H. Probst" <us*******@vbbox.com> wrote in message news:<e3**************@TK2MSFTNGP09.phx.gbl>...
If you use NDoc you can link your own HTML files into the finished CHM at
compile time.
--
____________________
Klaus H. Probst, MVP
http://www.vbbox.com/

"Bob Johnson" <bo*********@fastmail.fm> wrote in message
news:ec*************************@posting.google.co m...
I have looked through the docs for the XML documentation tags in the
C# Programmer's Reference, and I haven't come across a "MAINPAGE" tag
like you find in Doxygen. This tag is nice for when you want to give
the reader a broad overview of your software architecture and then
give them links to the main software blocks. Does anyone have any
experience creating main pages using the C# XML documenter?

--Bob

Nov 15 '05 #3
I'm not sure about that, I've never tried it. But by just looking at the
output files, it looks like NDoc generates pretty standard links that match
class names in the assemblies its documenting. You could probably figure out
what the link to a given class/enum/field/etc is going to look like and use
that.

Mind you NDoc may have some functionality that might help you with this.
It's extremely customizable, especially if you use the command line
interface instead of the GUI.
--
____________________
Klaus H. Probst, MVP
http://www.vbbox.com/

"Bob Johnson" <bo*********@fastmail.fm> wrote in message
news:ec*************************@posting.google.co m...
Can I create links back to the NDoc documentation inside my external
HTML files? The scenario here would be to write a class name in the
external HTML and have NDoc create a link to that class'
documentation.
"Klaus H. Probst" <us*******@vbbox.com> wrote in message

news:<e3**************@TK2MSFTNGP09.phx.gbl>...
If you use NDoc you can link your own HTML files into the finished CHM at compile time.
--
____________________
Klaus H. Probst, MVP
http://www.vbbox.com/

"Bob Johnson" <bo*********@fastmail.fm> wrote in message
news:ec*************************@posting.google.co m...
I have looked through the docs for the XML documentation tags in the
C# Programmer's Reference, and I haven't come across a "MAINPAGE" tag
like you find in Doxygen. This tag is nice for when you want to give
the reader a broad overview of your software architecture and then
give them links to the main software blocks. Does anyone have any
experience creating main pages using the C# XML documenter?

--Bob

Nov 15 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

10
by: Erwin Burgstaller | last post by:
When I have several header files with "namespace x {}" in each, the resulting doxygen documentation lists the Namespace exactly as often as there are header files with that namespace in. Thats only...
1
by: santa19992000 | last post by:
Can I give C++ code base from CVS to Doxygen for web interface?
5
by: Konrad Mühler | last post by:
Hallo, kennt jemand ein Forum oder eine Newsgroup in der Fragen zu Doxygen geklärt werden können? Habt Dank Konrad
6
by: NagitaK | last post by:
Thanks, NK
4
by: chrstian brensteiner | last post by:
--------------------8<--XX.h-------------------------- /** On shutdown the function shutdown() is called. The function destroys blablablabla. */ void shutdown();...
2
by: John Bowman | last post by:
Hi, Does anyone have any experience w/ using the Doxygen tool on C# code files? I'm evaluating it and noticed several methods are not appearing in the output. All classes, methods, properties...
2
by: David Dvali | last post by:
Hello. What is Doxygen tagging and how it can be used for source code documenting?
1
by: Jan Danielsson | last post by:
Hello all, I guess I should really be asking in some doxygen mailing list, but since I believe that I found doxygen through this group, I assume that there are some people here who can answer. ...
7
by: PeteOlcott | last post by:
So far I can only get Doxygen to generate callergraphs for ALL functions or for NO functions, Doxygen seems to be ignoring the \callergraph command. Does anyone know how to limit Doxygen to...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
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...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
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...
0
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...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.