TeamForge : Post

Forum Topic - Library API documentation -- Functiions by Category:

View: as

Kevin Stallard(deleted)

09/18/2009 12:41 PM

post38338

Library API documentation -- Functiions by Category

Howdy All,

I can't seem to find a section that used to be in the Runtime Library API documentation.  It was the functions organized
 by category.  Am I just blind, stupid and lazy or has this gone missing?

Thanks
Kevin

Steve Reid(deleted)

09/18/2009 1:19 PM

post38345

RE: Library API documentation -- Functiions by Category

We dropped that section a while ago because it was a nightmare to
maintain, and the index does a much better job of arranging things into
categories.

Steve Reid (stever@qnx.com)
Technical Editor
QNX Software Systems 
 

> -----Original Message-----
> From: Kevin Stallard [mailto:community-noreply@qnx.com] 
> Sent: Friday, September 18, 2009 12:41 PM
> To: ostech-core_os
> Subject: Library API documentation -- Functiions by Category
> 
> Howdy All,
> 
> I can't seem to find a section that used to be in the Runtime 
> Library API documentation.  It was the functions organized by 
> category.  Am I just blind, stupid and lazy or has this gone missing?
> 
> Thanks
> Kevin
> 
> 
> 
> 
> 
> _______________________________________________
> 
> OSTech
> http://community.qnx.com/sf/go/post38338
> 
>

Kevin Stallard(deleted)

09/18/2009 1:22 PM

post38346

Re: RE: Library API documentation -- Functiions by Category

Thanks Steve, I can understand that maintenance issue.  Just as feedback, even with the index, that section was helpful.
...

Thanks
Kevin

Kevin Stallard(deleted)

09/18/2009 1:47 PM

post38352

Re: RE: Library API documentation -- Functiions by Category

On second thought, I think you did the right thing.  I've had trouble finding things using the index before, it seemed 
too broad, but I just spent some time looking around it again, and with a little extra effort, the results are good.

Thanks
Kevin

Steve Reid(deleted)

09/18/2009 2:32 PM

post38354

RE: RE: Library API documentation -- Functiions by Category

That section was a holdover from the days when our documentation tools
couldn't produce an HTML index; it was better than nothing, but we kept
finding functions that belonged in more than one category -- which
seemed messy in that section, but perfectly acceptable in an index.

I'm glad you're finding the index useful. If you have any suggestions
for other entries, please let me know. 

Steve Reid (stever@qnx.com)
Technical Editor
QNX Software Systems

Oleh Derevenko(deleted)

09/18/2009 3:19 PM

post38360

Re: RE: RE: Library API documentation -- Functiions by Category

Categories were sometimes helpful when I could not remember the function name and had to just look through all the 
functions of a category, like all the math functions. That's a pity they are gone. :(

Steve Reid(deleted)

09/18/2009 3:28 PM

post38362

RE: RE: RE: Library API documentation -- Functiions by Category

If you go to the index and look up "mathematics", you'll find all the
functions listed there. We were careful to add index entries for all the
categories that were in the summary.


Steve Reid (stever@qnx.com)
Technical Editor
QNX Software Systems

Return