Bug #45352 Broken Links in Connector Documentation File
Submitted: 5 Jun 2009 13:57 Modified: 19 Jan 2010 17:35
Reporter: Glen Wilkinson Email Updates:
Status: Closed Impact on me:
Category:Connector / NET Documentation Severity:S2 (Serious)
Version: OS:Any
Assigned to: Reggie Burnett CPU Architecture:Any
Tags: chm, documentation, Help file

[5 Jun 2009 13:57] Glen Wilkinson
Summary documentation for features in the .Net Connector are missing or not properly linked.

I have included an example from the MySqlMebershipProvider.CreateUser Method to give an example.

I have unistalled the connector and reinstalled prior to bug submittal.



[Missing <summary> documentation for "M:MySql.Web.Security.MySQLMembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)"]

Namespace:  MySql.Web.Security
Assembly:  MySql.Web (in MySql.Web.dll) Version:

public override MembershipUser CreateUser(
	string username,
	string password,
	string email,
	string passwordQuestion,
	string passwordAnswer,
	bool isApproved,
	Object providerUserKey,
	out MembershipCreateStatus status
Visual Basic (Declaration) 
Public Overrides Function CreateUser ( _
	username As String, _
	password As String, _
	email As String, _
	passwordQuestion As String, _
	passwordAnswer As String, _
	isApproved As Boolean, _
	providerUserKey As Object, _
	<OutAttribute> ByRef status As MembershipCreateStatus _
) As MembershipUser
Visual C++ 
virtual MembershipUser^ CreateUser(
	String^ username, 
	String^ password, 
	String^ email, 
	String^ passwordQuestion, 
	String^ passwordAnswer, 
	bool isApproved, 
	Object^ providerUserKey, 
	[OutAttribute] MembershipCreateStatus% status
) override

Type: System..::.String

[Missing <param name="username"/> documentation for "M:MySql.Web.Security.MySQLMembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)"]

Type: System..::.String

[Missing <param name="password"/> documentation for "M:MySql.Web.Security.MySQLMembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)"]

Type: System..::.String

[Missing <param name="email"/> documentation for "M:MySql.Web.Security.MySQLMembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)"]


How to repeat:
Open Help search for any term.

Suggested fix:
Recompile CHM file post updated connector and put chm file on the documentation page for download.
[5 Jun 2009 14:05] Glen Wilkinson
Changed Tags
[9 Jun 2009 16:05] Tonci Grgin
Hi Glen and thanks for your report.
[19 Jan 2010 17:35] Reggie Burnett
Just checked docs for 6.0.5 and this has been fixed.