473,729 Members | 2,344 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

How to suppress "documentat ion missing" when overriding methods?

Hi,

I've a question about XML documentation of overridding methods and
methods implementing an interface declaration: These methods are
normally documented in the base class or interface. So I don't want to
write new documentation when overriding or implementing.

But if I leave out documentation and compile my assembly with
"/doc" the compiler warns me about missing documentation. How can I
tell the compiler that these methods don't need new documentation? How
can I tell the compiler that the base class or interface documentation
should be used? Can I add an attribute to the method to suppress the
warning?

Thanks,

Burkhard

--
Burkhard Perkens-Golomb mailto: bu************* ********@sdm.de
sd&m AG http://www.sdm.de
software design & management AG
Carl-Wery-Str. 42, 81739 Muenchen, Germany
Tel +49 89 63812-398, Fax -410
Tel Home +49 89 66 00 09 61
Nov 15 '05 #1
1 1612
Sorry there is no such attribute. Some people place their documentation in
a separate file and use the <include> tag to suck in the XML. If you're
using that, then you could easily just suck in the XML from the overridden
method...

--
--Grant
This posting is provided "AS IS" with no warranties, and confers no rights.
"Burkhard Perkens-Golomb" <bu************ *********@sdm.d e> wrote in message
news:rv******** *****@alkofen.m uc.sdm.de...
Hi,

I've a question about XML documentation of overridding methods and
methods implementing an interface declaration: These methods are
normally documented in the base class or interface. So I don't want to
write new documentation when overriding or implementing.

But if I leave out documentation and compile my assembly with
"/doc" the compiler warns me about missing documentation. How can I
tell the compiler that these methods don't need new documentation? How
can I tell the compiler that the base class or interface documentation
should be used? Can I add an attribute to the method to suppress the
warning?

Thanks,

Burkhard

--
Burkhard Perkens-Golomb mailto: bu************* ********@sdm.de
sd&m AG http://www.sdm.de
software design & management AG
Carl-Wery-Str. 42, 81739 Muenchen, Germany
Tel +49 89 63812-398, Fax -410
Tel Home +49 89 66 00 09 61

Nov 15 '05 #2

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

Similar topics

2
1811
by: Ira Baxter | last post by:
My understanding is that Zend are the folks behind the one and only PHP implementation. Now that PHP5 is released, I'm quite interested in using it. However, the documentation avialable at PHP.NET suggests that it isn't by Zend. What reason is there to believe it is complete and accurate in any sense? (There's lot of user clarifications which show that it isn't complete). In particular, the section of PHP5 has parts that are...
5
3429
by: BoonHead, The Lost Philosopher | last post by:
Does anyone know how to implement internal interface documentation for functions and parameters? I found a similair thing for proerties. For properties I found something like: <System.ComponentModal.Description("This property sets aars!")> Property Aars() As Boolean '...Property body... End Property
2
1753
by: Kalle Anke | last post by:
I'm confused of how I should document my code, I've always liked being able to document my code directly in my source file and then to use some tool to extract the documentation to some other format. My problem with Python is that there are so many tools and formats ... I don't know which one I should use. I've tried to figure out if there is one that is the "de-facto standard" but ... Could someone advice me on what format/tool I...
4
38734
by: Bill Dee | last post by:
I use XML comments around most of my class libraries public property and methods, for example: /// <summary> /// blah blah /// </summary> However I have a few dozen public constants as well as a few properties and methods that I do not want to provide any XML comments for. This generates errors like this:
0
1559
by: Sean Quilty | last post by:
Help! We are getting the following errors on a slave server: 060304 7:42:03 Error reading packet from server: Could not find first log (server_errno=65535) 060304 7:43:03 Slave: Failed reading log event, reconnecting to retry, log 'wcassp801.2514' position 76 060304 7:43:03 Slave: reconnected to master 'repl@10.20.10.10:3306',replication resumed in log 'wcassp801.2514' at position 76 We are running mysql v3.23.58-max-log on a...
1
4284
by: BobPaul | last post by:
I'm following code out of a howto book and this is really bugging me. This header file was created by VStudio 6.0 when I did a "Right Click: Add Member Function" CLine is a class I wrote (per the book's instructions) and Line.h in included in Day10Doc.cpp Here is the contents of Day10Doc.h #if !defined(AFX_DAY10DOC_H__16736853_CB29_49E7_A8ED_C912CAE666EC__INCLUDED_) #define AFX_DAY10DOC_H__16736853_CB29_49E7_A8ED_C912CAE666EC__INCLUDED_ ...
5
3293
by: Miro | last post by:
My form suddenly wouldnt compile. It had an error - main form must be specified. So i went to my Solution and went to properties. In the Application Tab I reset my opening form, but my "Enable Application Framework" checkbox is missing and everything under it is missing. If I create a new solution I have the options. Is my only choice to recreate a new solution and re-imput all my forms? I
2
1505
by: pedestrian via SQLMonster.com | last post by:
I wonder is there any way I can turn off the "Documentation Feedback" section of the Books Online at the bottom of the pages... I'm printing some Books Online pages for own reference. Thanks in advance... -- Message posted via SQLMonster.com http://www.sqlmonster.com/Uwe/Forums.aspx/sql-server-general/200706/1
4
7202
benchpolo
by: benchpolo | last post by:
I modified my existing MsAccess (.mdb) database with addtional queries and report. When I updated the version in my other pc with the new version when I loaded the database an error popped-out that i am missing a plugin.ocx. This is the first time i have encountered this message on MsAccess 2003. What is the cause for this missing .ocx addins? How can this be prevented in the future? Is there a fix for this? Assistance will be much...
0
8917
marktang
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...
0
8761
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,...
0
9426
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
9281
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 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...
1
9200
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,...
0
8148
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, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
6722
isladogs
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...
0
6022
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();...
3
2163
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.