Documentation Generation and "IsWrapped=false"

Topics: General Discussion Forum
Nov 22, 2009 at 10:08 PM

 

 

 

i
I've built a WCF Service using the Web Service Software Factory (www.codeplex.com/servicefactory). I'm trying to make a CHM help file for users of the web service. When I build a help file (using Sandcastle) the help file doesn't match the interface displayed to users. 
Let's take the case of a method in the service called CustomerGetById(). This takes an ID and returns a customer object. Using the software factory designer it is necessary to create a message object to contain the input parameter which is simply a integer. However, the service designer allows you to hide this message class from the user since it is useless in this case.
Unfortunately the help file contains the message class which adds to the complexity of the design and will confuse users. Does anyone know how to make it follow the interface that is exposed to service users?
Cheers
Mark
i
I've built a WCF Service using the Web Service Software Factory (www.codeplex.com/servicefactory). I'm trying to make a CHM help file for users of the web service. When I build a help file (using Sandcastle) the help file doesn't match the interface displayed to users. 
Let's take the case of a method in the service called CustomerGetById(). This takes an ID and returns a customer object. Using the software factory designer it is necessary to create a message object to contain the input parameter which is simply a integer. However, the service designer allows you to hide this message class from the user since it is useless in this case.
Unfortunately the help file contains the message class which adds to the complexity of theH design and will confuse users. Does anyone know how to make it follow the interface that is exposed to service users?
Cheers
Mark

Hi

I've built a WCF Service using the Web Service Software Factory. I'm trying to make a CHM help file for users of the web service. When I build a help file (using Sandcastle) the help file doesn't match the interface displayed to users. 

Let's take the case of a method in the service called CustomerGetById(). This takes an ID and returns a customer object. Using the software factory designer it is necessary to create a message object to contain the input parameter which is simply a integer. However, the service designer allows you to hide this message class from the user since it is useless in this case. It adds this to the message contract: [WCF::MessageContract(IsWrapped = false)] 

Unfortunately the help file contains the message class. Does anyone know how to make it follow the interface that is exposed to service users?

Cheers

Mark

 

 

 

 

 

Developer
Nov 22, 2009 at 10:49 PM

In that case perhaps you may use the client proxy class (generated with WSSF or svcutil tool) and that way you may show exactly the same interface that will call the service consumer (client). As you describe, I assume that you are calling the service or using the WSDL to generate the documented interface.