• Pierre Rouleau (37/37) Dec 05 2003 I just downloaded STLSoft and am currently trying to get it running with...
• Matthew Wilson (15/50) Dec 09 2003 I'll attend to these before the next release.

Pierre Rouleau <prouleau impathnetworks.com> writes:

I just downloaded STLSoft and am currently trying to get it running with 
DMC.  I must join everyone here that praised that great piece of work. 
Thanks!

Browsing through the source code and the Doxygen generated docs, I came 
across some minor Doxygen commenting omission, where:

\ref concepts_shims "shims"

is instead typed as:

ref concepts_shims "shims"

This makes the text show up in the docs instead of the link.  Juts a 
minor point.

The affected files in the 1.7.1 beta version are:

stlsoft_null_mutex.h:/// This control ref concepts_shims "shim" releases 
a lock on the given mutex
unixstl_process_mutex.h:/// This control ref concepts_shims "shim" 
aquires a lock on the given mutex
unixstl_process_mutex.h:/// This control ref concepts_shims "shim" 
releases a lock on the given mutex
unixstl_thread_mutex.h:/// This control ref concepts_shims "shim" 
aquires a lock on the given mutex
unixstl_thread_mutex.h:/// This control ref concepts_shims "shim" 
releases a lock on the given mutex
winstl_process_mutex.h:/// This control ref concepts_shims "shim" 
aquires a lock on the given mutex
winstl_process_mutex.h:/// This control ref concepts_shims "shim" 
releases a lock on the given mutex
winstl_spin_mutex.h:/// This control ref concepts_shims "shim" aquires a 
lock on the given mutex
winstl_spin_mutex.h:/// This control ref concepts_shims "shim" releases 
a lock on the given mutex
winstl_thread_mutex.h:/// This control ref concepts_shims "shim" aquires 
a lock on the given mutex
winstl_thread_mutex.h:/// This control ref concepts_shims "shim" 
releases a lock on the given mutex


Is there a spot where we can upload modified versions of the files or 
report bugs?


Thanks again,


Pierre

"Matthew Wilson" <matthew.hat stlsoft.dot.org> writes:

 I just downloaded STLSoft and am currently trying to get it running with
 DMC.  I must join everyone here that praised that great piece of work.
 Thanks!

That's very gratifying. Thanks. :)

 Browsing through the source code and the Doxygen generated docs, I came
 across some minor Doxygen commenting omission, where:

Undoubtedly. The documentation is something that leaves a lot to be desired.

 \ref concepts_shims "shims"

 is instead typed as:

 ref concepts_shims "shims"

 This makes the text show up in the docs instead of the link.  Juts a
 minor point.

 The affected files in the 1.7.1 beta version are:

 stlsoft_null_mutex.h:/// This control ref concepts_shims "shim" releases
 a lock on the given mutex
 unixstl_process_mutex.h:/// This control ref concepts_shims "shim"
 aquires a lock on the given mutex
 unixstl_process_mutex.h:/// This control ref concepts_shims "shim"
 releases a lock on the given mutex
 unixstl_thread_mutex.h:/// This control ref concepts_shims "shim"
 aquires a lock on the given mutex
 unixstl_thread_mutex.h:/// This control ref concepts_shims "shim"
 releases a lock on the given mutex
 winstl_process_mutex.h:/// This control ref concepts_shims "shim"
 aquires a lock on the given mutex
 winstl_process_mutex.h:/// This control ref concepts_shims "shim"
 releases a lock on the given mutex
 winstl_spin_mutex.h:/// This control ref concepts_shims "shim" aquires a
 lock on the given mutex
 winstl_spin_mutex.h:/// This control ref concepts_shims "shim" releases
 a lock on the given mutex
 winstl_thread_mutex.h:/// This control ref concepts_shims "shim" aquires
 a lock on the given mutex
 winstl_thread_mutex.h:/// This control ref concepts_shims "shim"
 releases a lock on the given mutex

I'll attend to these before the next release.

 Is there a spot where we can upload modified versions of the files or
 report bugs?

You just did. ;)

If you have any other issues with the documentation, feel free to email me
(matthew hat synesis dot com dot au), or post here.

Cheers


-- 
Matthew Wilson

STLSoft moderator  (http://www.stlsoft.org)
Contributing editor, C/C++ Users Journal
(www.synesis.com.au/articles.html#columns)

"But if less is more, think how much more more will be!" -- Dr Frazier Crane

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