Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-devel / 2010-02

ref.tex documentation mistake

4 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Graeme Geldenhuys

Hi Michael,

I updated my fpcdocs repository from r625 (pre 2.4.0 release) to r634 (post 2.4.0 release), but still found a bug in documentation and missing information related to FPC 2.4.0

1) Wrong Information:
-----------[ ref.tex line 1340 ]------------------------- \subsection{WideStrings}
\index{Widestring}\index{Types!Widestring}\index{Types!Reference counted} \keywordlink{Widestring}
Widestrings (used to represent unicode character strings) are implemented in much
the same way as ansistrings: reference counted, null-terminated arrays, only they
are implemented as arrays of \var{WideChars} instead of regular \var{Chars}. ----------------------------------------------------------

WideString is not reference counted on all platforms. On Windows it is _not_ reference counted as far as I know. This is done to be compatible with COM string type behaviour.

2) Missing information:
Under "Character Types", there is no documentation on the new type "UnicodeString". To add to this, UnicodeString is exactly the same as WideString _except_ that it IS reference counted on all platforms.

Regards,
- Graeme -

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://opensoft.homeip.net/fpgui/

Reply by email

Michael Van Canneyt
to Graeme Geldenhuys
Graeme Geldenhuys wrote 27 lines
Hi Michael, I updated my fpcdocs repository from r625 (pre 2.4.0 release) to r634 (post 2.4.0 release), but still found a bug in documentation and missing information related to FPC 2.4.0 1) Wrong Information: -----------[ ref.tex line 1340 ]------------------------- \subsection{WideStrings} \index{Widestring}\index{Types!Widestring}\index{Types!Reference counted} \keywordlink{Widestring} Widestrings (used to represent unicode character strings) are implemented in much the same way as ansistrings: reference counted, null-terminated arrays, only they are implemented as arrays of \var{WideChars} instead of regular \var{Chars}. ---------------------------------------------------------- WideString is not reference counted on all platforms. On Windows it is _not_ reference counted as far as I know. This is done to be compatible with COM string type behaviour. 2) Missing information: Under "Character Types", there is no documentation on the new type "UnicodeString". To add to this, UnicodeString is exactly the same as WideString _except_ that it IS reference counted on all platforms.

It was already on my TODO list for 2.4 (together with resources), but I didn't get around to it.

Michael.

Reply by email

Graeme Geldenhuys
to Michael Van Canneyt
Michael Van Canneyt wrote
It was already on my TODO list for 2.4 (together with resources), but I didn't get around to it.

Thanks, I remember a while back you mentioned you had a documentation todo list for FPC 2.4 release - I assumed you completed the todo list as 2.4 is already released. With that, I thought I would mention the UnicodeString oversight. ;-)

Regards,
- Graeme -

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://opensoft.homeip.net/fpgui/

Reply by email

Michael Van Canneyt
to Graeme Geldenhuys
Graeme Geldenhuys wrote 9 lines
Michael Van Canneyt wrote: > > It was already on my TODO list for 2.4 (together with resources), > but I didn't get around to it. Thanks, I remember a while back you mentioned you had a documentation todo list for FPC 2.4 release - I assumed you completed the todo list as 2.4 is already released. With that, I thought I would mention the UnicodeString oversight. ;-)

If my todolist was a mountain, mount Everest would look like a mere mole heap in comparison.

Michael.

Reply by email