IonicWind Software

Aurora Compiler => General Discussion => Topic started by: Kale on September 06, 2006, 03:15:55 PM

Title: Request for the Help Docs...
Post by: Kale on September 06, 2006, 03:15:55 PM
In the help doc are you planning to add more clickable links in the descriptions? For example In this page:


C3DMesh::SetMaterial

--------------------------------------------------------------------------------

Syntax:
SetMaterial(D3DMATERIAL material);
Purpose:
  Class Method

  The description goes here

Passed value(s):
material    Description goes here

Returned value(s):
None       

Application:

example code goes here

Class Hierarchy
C3DObject


-------C3DMesh


Additional Info:
  Any remarks go here

See Also:


Can the 'D3DMATERIAL' structure be made into a link leading to the relevant page please? And so on with the other structs, etc... ;D
Title: Re: Request for the Help Docs...
Post by: Ionic Wind Support Team on September 06, 2006, 04:18:58 PM
Yes when it is done there are 'see also' links.
Title: Re: Request for the Help Docs...
Post by: Kale on September 06, 2006, 04:45:42 PM
Quote from: Paul Turley on September 06, 2006, 04:18:58 PM
Yes when it is done there are 'see also' links.

Cool! :D
Title: Re: Request for the Help Docs...
Post by: LarryMc on September 06, 2006, 04:46:52 PM
Paul,
do you want me to fix it so that, if the type is a structure/class in the actual declare parameters, it will be a link? ÂÃ, I had already thought about doing that. ÂÃ, Just requires some doctoring of the templates. ÂÃ, It would keep you from having to enter a "see also" link for those items.

Let me know.

If you remember I had the type (/w link if it was structure/class) in the parameter list along with the name and description ÂÃ,  but you had me remove it because it was redundant to the declare statement.



Larry
Title: Re: Request for the Help Docs...
Post by: Ionic Wind Support Team on September 06, 2006, 05:03:30 PM
See also would be fine.  Or even a link on the parameter itself.
Title: Re: Request for the Help Docs...
Post by: Kale on September 06, 2006, 05:05:18 PM
Quote from: Paul Turley on September 06, 2006, 05:03:30 PM
See also would be fine.  Or even a link on the parameter itself.

Parameter links would be nice. :)