Author Topic: Documentation  (Read 58779 times)

0 Members and 1 Guest are viewing this topic.

Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 4486
    • Oxygen Basic
Re: Documentation
« Reply #30 on: September 27, 2018, 02:50:43 am »
but you will be overflowing into unallocated space. Allocate some more chars:

Code: [Select]
CHAR c[100] = "Test string"
c += " - more text"
print c

José Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #31 on: September 27, 2018, 02:55:50 am »
It was too good to be true :)

Aurel

  • Guest
Re: Documentation
« Reply #32 on: September 27, 2018, 04:43:23 am »
Quote
It was too good to be true

Yes Jose o2 in many things is excellent  :D

John

  • Hero Member
  • *****
  • Posts: 3966
Re: Documentation - OT
« Reply #33 on: September 27, 2018, 08:56:16 am »
Quote
It was too good to be true.

Why no one uses SB.  :-\

John

  • Hero Member
  • *****
  • Posts: 3966
Re: Documentation
« Reply #34 on: September 27, 2018, 10:35:53 pm »
José,

The O2 docs in development on your WinPBX repository are looking good.

If Charles doesn't want to expand on his repository, I think a project repository needs to be setup for source control and documentation.

I think there should be two branches. What we have now and Charles's new self compile direction.
« Last Edit: September 27, 2018, 10:42:54 pm by John »

Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 4486
    • Oxygen Basic
Re: Documentation
« Reply #35 on: September 27, 2018, 11:24:29 pm »
The core is mostly the same, but there are a few changes like Booleans producing 1 instead of -1.

José Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #36 on: September 29, 2018, 02:19:23 pm »

John

  • Hero Member
  • *****
  • Posts: 3966
Re: Documentation
« Reply #37 on: September 29, 2018, 02:22:29 pm »
Outstanding!

Thanks for your efforts. Obtaining your interests is like hitting the jackpot.

Mike Lobanovsky

  • Hero Member
  • *****
  • Posts: 1993
Re: Documentation
« Reply #38 on: September 29, 2018, 02:35:34 pm »
Thank you, José!
Mike
(3.6GHz Intel Core i5 Quad w/ 16GB RAM, nVidia GTX 1060Ti w/ 6GB VRAM, Windows 7 Ultimate Sp1)

John

  • Hero Member
  • *****
  • Posts: 3966
Re: Documentation
« Reply #39 on: September 29, 2018, 02:40:25 pm »
Maybe it's just me but developing O2 docs on a PowerBASIC repository makes this project seem like PBLite:-\

I would be happy to create an O2 project repository and make Charles and José administrators.

If we had a source control repository maybe Charles could acquire some help rather than only accepting example results of his efforts.
« Last Edit: September 29, 2018, 02:53:09 pm by John »

José Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #40 on: September 29, 2018, 02:54:06 pm »
They're simply draft pages.  They can be copied, revised and updated later in an O2 repository. Meanwhile, I have to keep them somewhere.

John

  • Hero Member
  • *****
  • Posts: 3966
Re: Documentation
« Reply #41 on: September 29, 2018, 04:18:39 pm »
Agreed.

My point is we need to get source control going. Zips on a Github repository isn't its purpose.

I think Gitlab has a server version that would allow O2 a private repository with markup docs if that would solve the private ownership concerns.
« Last Edit: September 29, 2018, 04:25:42 pm by John »

Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 4486
    • Oxygen Basic
Re: Documentation
« Reply #42 on: September 29, 2018, 10:02:27 pm »

Many thanks, José. That is very clear documentation, and the style is attractive.

But one point I need to make is that o2 has case-sensitive modes to cope with C-headers, like gl.h. If we use #case capital, then fully capitalised keywords will not be recognised.

José Roca

  • Sr. Member
  • ****
  • Posts: 263
Re: Documentation
« Reply #43 on: September 30, 2018, 02:46:18 am »
Then I will have to change everything to lowercase. I'm not certainly the best suited to write O2 documentation, because I still don't fully know the language (I'm learning it while I try to write the documentation), and English is no my mother language, but somebody has to do something about it. If I'm having problems, imagine a beginner...

And what "case capital" does?



Charles Pegge

  • Admin Support Member
  • *****
  • Posts: 4486
    • Oxygen Basic
Re: Documentation
« Reply #44 on: September 30, 2018, 03:34:22 am »
There are 3 #cases:

#case insensitive  'converts words to lowercase 'default

#case sensitive  'no case conversion 'like C etc

#case capital  'convert to lowercase, except for all-uppercase words

C headers often have all-uppercase equates or types with the same spelling as some of their procedure names. And we have to maintain that distinction in order to use such headers unmodified.