Index

From: Andy Elmhorst
Subject: Re: TeeGopher 2.0 Issue
Date: Tue, 9 Sep 2003 09:01:10 -0500
Newsgroup: steema.public.teegofer2.general  

This is not the behavior that Ndoc = follows. It also=20 does not follow the pattern the Microsoft uses in their own code = documentation.=20 I would prefer if this could be made an option in TeeGofer and not the = default=20 behavior. We have thousands of code comments that are going to be = affected by=20 this.
 
I would expect the default behavior to = be for the=20 help generator to automatically convert any whitespace ( including = carriage=20 returns and line feeds ) to spaces in the html version.
 
Regards,
 
Andy Elmhorst
Software Engineer
Renaissance Learning, Inc.
 
 
"Christopher Ireland" <support@steema.removethis.c= om>=20 wrote in message news:SRH6$JXNDHA.488@TEEPC...
Hi Marc,
 
>It looks like Tee Gopher is = not=20 concatenating a space onto the end of a multi-line summary = tag.
 
No, this behaviour was changed = upon request.=20 In TeeGofer v2 you will have to expressly leave white spaces in the = position=20 you want them to appear; for example, the summary tag below appears = correctly=20 in TeeGofer v2 because there is a space character at the end of each = line=20 (except the last one):
 
/// <summary>
/// = Maintains a dynamic=20 collection of helper objects, used to construct objects in the system. = The=20 collection of
/// helpers is intended to be displayed from a list = in a=20 user-interface component, so that a user can
/// directly execute = them.=20 Each helper provides a name, descriptive text and an array of = descriptions=20
/// of parameters that are required by the helper. The = user-interface=20 component will typically display
/// the names of available = helpers,=20 optionally display the descriptive text, and use the list of parameter =
///=20 descriptions to adequately execute the helper.
///=20 </summary>
 
You should be able to see this = multi-line=20 summary tag working by simply cutting and pasting it into your=20 code.

--
Best Regards,
 
Christopher Ireland
chris@steema.com
"Mark Meier" <markmeier@comcast.net> = wrote in=20 message news:hhCKoMQNDHA.488@TEEPC...
It looks like Tee Gopher is not = concatenating a=20 space onto the end of a multi-line summary tag.  Thus, when the = multi-line comment is converted to a help file words at the end of = the=20 previous line run together with words from the beginning of the = next. =20 Tee Gopher 1 didn't have this problem.
 
This is a bit of an = issue actually -- I've=20 got lots of multi-line comments in my source.
 
Here's an example from = 2.0:
---
Maintains a dynamic collection of = helper=20 objects, used to construct objects in the system. The collection=20 ofhelpers is intended to be displayed from a list = in a=20 user-interface component, so that a user = candirectly=20 execute them. Each helper provides a name, descriptive text and an = array of=20 descriptionsof parameters that are required by the = helper.=20 The user-interface component will typically = displaythe=20 names of available helpers, optionally display the descriptive text, = and use=20 the list of parameterdescriptions to adequately = execute the=20 helper.
---
Here's the same example in = 1.0:
---
Maintains a dynamic collection of = helper=20 objects, used to construct objects in the system. The collection of = helpers=20 is intended to be displayed from a list in a user-interface = component, so=20 that a user can directly execute them. Each helper provides a name,=20 descriptive text and an array of descriptions of parameters that are = required by the helper. The user-interface component will typically = display=20 the names of available helpers, optionally display the descriptive = text, and=20 use the list of parameter descriptions to adequately execute the=20 helper.
---
 
Sincerely,
Mark