Wiki improvements

Forum for discussion about the documentation project.
srvaldez
Posts: 2152
Joined: Sep 25, 2005 21:54

Re: Wiki improvements

Postby srvaldez » Sep 10, 2019 17:53

hello fxm
I had a quick look, and it looks very good to me, thank you :-)
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 12, 2019 8:14

fxm wrote:This is progressing well in my opinion (started since September 2, 2019).
Go see it if the above subject interests you !

New complete sub-section added in the Programmer's Guide:

Multi-Threading
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 12, 2019 20:18

@admin,

About 6 months ago, I proposed to close this bug report (which I had created myself), but no reaction since?
#807 'ScreenSet' ordering in main thread is ignored by user threads even created after that!
coderJeff
Site Admin
Posts: 3133
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Sep 12, 2019 22:43

fxm wrote:@admin,

About 6 months ago, I proposed to close this bug report (which I had created myself), but no reaction since?
#807 'ScreenSet' ordering in main thread is ignored by user threads even created after that!

There are several gfxlib2 and threading bugs which may or may not be related to each other. Sorry, I've been focused on other areas of the compiler that I did not read this bug. I have read it now. My opinion is that it is worth keeping open until the gfxlib2 and threading bugs are reviewed as a whole. Your note about gfxlib2 using thread local storage (TLS) in #807 reminds that commit 58a795... adds new data that is not in TLS.
coderJeff
Site Admin
Posts: 3133
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Sep 12, 2019 23:09

fxm wrote:
fxm wrote:New complete sub-section added in the Programmer's Guide:

Multi-Threading

Wow! I've read the new topics. They are very good with a logical progression of topics and information. Wonderful work, fxm.
D.J.Peters
Posts: 7852
Joined: May 28, 2005 3:28

Re: Wiki improvements

Postby D.J.Peters » Sep 13, 2019 0:27

coderJeff wrote:Wow! I've read the new topics. They are very good with a logical progression of topics and information. Wonderful work, fxm.
Same here well done.

Joshy
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 18, 2019 6:11

About the "Programmer's Guide / Procedures / Procedure Scopes" page

- Is the purpose of describing the scope of variables within a procedure?
    In this case, already covered by "Programmer's Guide / Declarations / Variable Scope" page.
- Or to speak about the visibility of the procedures through the different modules?
    But then, a page for a few lines!
    (can be added in the "Procedures Overview" page)
coderJeff
Site Admin
Posts: 3133
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Sep 19, 2019 1:51

fxm wrote:- Or to speak about the visibility of the procedures through the different modules?

My guess is that Procedure Scopes title might be reserved for this concept.
- private, visible within a module
- public, visible within an executable
- export, visible between executables

But that's just a guess because I don't remember. And there is nothing on Missing Documentation that gives us a hint.
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 26, 2019 15:11

'Assignments' page filled in the Programmer's Guide / Statements and Expressions:
- ProPgAssignments → fxm [new page created]
- CatPgProgrammer → fxm [added link to "Assignments" page]
- PrintToc → fxm [added link to "Assignments" page]

[edit]
'Procedure Scopes' page previously filled in the Programmer's Guide / Procedures.
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 28, 2019 15:48

'Constants and Enumerations' page filled in the Programmer's Guide / Variables and Datatypes:
- ProPgEnumerations → fxm [new page created]
- CatPgProgrammer → fxm [added link to "Constants and Enumerations" page]
- PrintToc → fxm [added link to "Constants and Enumerations" page]
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 30, 2019 6:21

'Numeric Types' page filled in the Programmer's Guide / Variables and Datatypes:
- ProPgNumericTypes → fxm [new page created]
- CatPgProgrammer → fxm [added link to "Numeric Types" page]
- PrintToc → fxm [added link to "Numeric Types" page]
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Sep 30, 2019 15:13

'Strings (string, zstring, and wstring)' page filled in the Programmer's Guide / Variables and Datatypes:
- ProPgStringsTypes → fxm [new page created]
- CatPgProgrammer → fxm [added link to "Strings (string, zstring, and wstring)" page]
- PrintToc → fxm [added link to "Strings (string, zstring, and wstring)" page]

Now I'm taking a big break!
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Oct 04, 2019 18:29

'Overview', 'Conditional Compilation' and 'Macros' pages filled in the Programmer's Guide / Preprocessor:
- ProPgPreprocessor → fxm [new page created]
- ProPgConditionalCompilation → fxm [new page created]
- ProPgMacros → fxm [new page created]
fxm
Posts: 9304
Joined: Apr 22, 2009 12:46
Location: Paris suburbs, FRANCE

Re: Wiki improvements

Postby fxm » Oct 05, 2019 9:27

If someone else could fill in the last two remaining pages "Graphics / External Graphics File Formats" and "Making Binaries / Executables" (it's outside of my skills), it would be nice to finally have a complete Programmer's Guide.

If it is only formatting on the wiki that annoys some, they can write free text on a page that I would format later.
coderJeff
Site Admin
Posts: 3133
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » Oct 14, 2019 18:23

fxm, your work is fabulous. We are so close to remove the "Work in progress" notice on the programmer's guide. Thank-you.

Yes, would be nice if there was someone besides you or me to help...

For executables topic: I think this should describe the components: (object modules and/or import library and/or library) => executable.

For external graphics file formats topic: what is supported by BLOAD & BSAVE. To be cross platform, the QB/BMP formats that can be loaded/saved are hard coded in the rtlib. So, this is will be a description of what is specifically supported by the rtlib.

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 1 guest