This project has moved and is read-only. For the latest updates, please go here.

Inserting "nonexistent" parameters / property desc.

Topics: Developer Forum
May 20, 2008 at 12:00 AM
I'm using a transform to create a "content only" XML file to overwrite and add to the comments coming from the source. Without going into the "why" of it, I figured I could plug some data into a <parameter> tag and have it show up under the method even though the method doesn't actually take parameters. Apparently this doesn't work. Will SC (or SFHB) not allow a <parameter> tag for a method whose reflection indicates that it doesn't take a parameter? My <remarks> go in just fine, so I know the file is being read and applied.

May 20, 2008 at 2:17 AM
Parameter elements have a required name attribute that names the parameter.  Sandcastle will only output parameter info if it see parameters on the method in the reflection info.  If there are no parameters, you won't get a parameters section.  Add your comments to the remarks element instead.