<seealso cref= to Class Constructor fails

  • Thread starter Thread starter Mark Johnson
  • Start date Start date
M

Mark Johnson

I am trying to get a seealso link to the Class Constructor where a Field is
set.
This seems to be the last major problem to get a Warning free compulation,
so it would be nice to get it solved.
There are two Constructors in this class and I have tried the following :
/// <seealso cref="Cards.Cards(Panel,string,int,int,int)"/>
or
/// <seealso cref="Cards.Cards()"/>
or
/// <seealso cref="Cards.Cards"/>

all of which failed (Function could not be found - "'Cards.Cards', das nicht
gefunden werden konnte").

Any help to get this solved would be nice.

Mark Johnson, Berlin Germany
(e-mail address removed)
 
You need the full namespace to the method and when specifying a method with
arguments you need the full namespaces for each type passed e.g.

<seealso
cref="MyCompany.MyProduct.Cards.Cards(System.Windows.Forms.Panel,System.Stri
ng,System.Int32,System.Int32)"/>

Peter
 
Peter Foot said:
You need the full namespace to the method and when specifying a method with
arguments you need the full namespaces for each type passed e.g.

<seealso
cref="MyCompany.MyProduct.Cards.Cards(System.Windows.Forms.Panel,System.Stri
ng,System.Int32,System.Int32)"/>
Click to expand...

No you don't. The documentation compiler puts it in automatically.
However, you don't want the double "Cards" bit there. You should leave
the second one out entirely. For instance:

using System;
using System.Drawing;

/**
* <seealso cref="Point(int)" />
*/
public class Test
{
}

I believe you would need to put the full namespace etc in if you also
had a method with the signature Point(int).

Here's the XML generated for the above:

<?xml version="1.0"?>
<doc>
<assembly>
<name>Test</name>
</assembly>
<members>
<member name="T:Test">
<seealso cref="M:System.Drawing.Point.#ctor(System.Int32)"/>
</member>
</members>
</doc>

Unfortunately specifying the "#ctor" directly doesn't work.
 
/// <seealso
cref="mj10777_Cards.Cards(System.Windows.Forms.Panel,System.String,System.In
t32,System.Int32,System.Int32)"/>
/// <seealso
cref="mj10777_Cards.Players(mj10777_Cards.Cards,System.Int32,System.Int32,Sy
stem.Int32)"/>


Works correctly.

Thank you for your help.

Mark Johnson, Berlin Germany
(e-mail address removed)
 
/// <seealso
cref="Cards(System.Windows.Forms.Panel,String,Int32,Int32,Int32)"/>
/// <seealso cref="Players(Cards,Int32,Int32,Int32)"/>
Both ot these work (inside the namespace of cource).
I assume if I add a "using System.Windows.Forms;" ,
Cards(Panel,String,Int32,Int32,Int32) would also work.

Mark Johnson, Berlin Germany
(e-mail address removed)
 
Yes it will any type in a namespace which is in scope in your current code
file. The only exception would be if there was more than one class called
Image accessible e.g. System.Drawing.Image and MyApp.Image in which case you
would need the full namespace to avoid ambiguity.

Peter

--
Peter Foot
Windows Embedded MVP
OpenNETCF.org Senior Advisor
www.inthehand.com | www.opennetcf.org

Mark Johnson said:
/// <seealso
cref="Cards(System.Windows.Forms.Panel,String,Int32,Int32,Int32)"/>
/// <seealso cref="Players(Cards,Int32,Int32,Int32)"/>
Both ot these work (inside the namespace of cource).
I assume if I add a "using System.Windows.Forms;" ,
Cards(Panel,String,Int32,Int32,Int32) would also work.

Mark Johnson, Berlin Germany
(e-mail address removed)



cref="MyCompany.MyProduct.Cards.Cards(System.Windows.Forms.Panel,System.Stri
Click to expand...
 
Back
Top