Wiki improvements

Forum for discussion about the documentation project.
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 19, 2018 5:50

It works only if I fill my new moderator field: 'Reason for editing this post:', otherwise the post history is not incremented.
Weird, I think it was not like that at first!
(I am talking about the Document forum)
coderJeff
Site Admin
Posts: 2614
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » May 19, 2018 20:50

yes, correct. For admins/moderators, the last edited by ... is only updated when a reason is given. That's not a board/user choice, just how phpBB works.
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 19, 2018 20:56

How/Why to Define Constructors, Destructor, Copy-Constructor, Assignment-Operator in FB UDT (article)

In progress.
The subject is not easy to present in a concise article but still quite complete.
First output probably during next week.
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 21, 2018 13:04

Phew, the post is out, some rest !
Now to others also to provide or point texts for articles.
paul doe
Posts: 549
Joined: Jul 25, 2017 17:22
Location: Argentina

Re: Wiki improvements

Postby paul doe » May 21, 2018 20:36

fxm wrote:Phew, the post is out, some rest !
Now to others also to provide or point texts for articles.

Rest now, you deserve it =D

Can I suggest the FBeginner resource to be added to the index? It's a bit old (for ver. 0.17), but most of the information could still be useful for entry level programmers.
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 21, 2018 21:53

Good idea.
Done it.
paul doe
Posts: 549
Joined: Jul 25, 2017 17:22
Location: Argentina

Re: Wiki improvements

Postby paul doe » May 21, 2018 22:03

Excellent! The index is looking great, very nice work!
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 22, 2018 9:01

fxm wrote:Now to others also to provide or point texts for articles.
or at least to plebiscite article topics :-)
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 26, 2018 17:56

I am therefore waiting for proposals for other topics of articles.
I can take them into account if I have the skills or material, but any other person (for reformulating, complementing or even creating from scratch) is welcome.
I hope that among all participants in previous discussions on improving documentation (and also those who have expressed their dissatisfaction), there will also be some volunteers to do so.
Josep Roca
Posts: 335
Joined: Sep 27, 2016 18:20
Location: Valencia, Spain

Re: Wiki improvements

Postby Josep Roca » May 26, 2018 19:41

What about the use of PRIVATE to achieve dead code removal?
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 26, 2018 20:23

Perhaps a slightly more general article outlining the method and benefit of using a different mean than creating libraries to easily access reusable procedures:
- Use the preprocessor statement to include the contents of other source files (#include [once] "file") into the main source program.
- Group the reusable procedures within source files to include, declaring these procedures as Private.

Can you write something about this?

Possible title (in line with the other titles):
How to Manage FB Reusable Procedures by Including Source Modules (vs. compiled modules)
Josep Roca
Posts: 335
Joined: Sep 27, 2016 18:20
Location: Valencia, Spain

Re: Wiki improvements

Postby Josep Roca » May 26, 2018 21:04

You already have outlined all what is needed: "Group the reusable procedures within source files to include, declaring these procedures as Private." and when you need to access a procedure "Use the preprocessor statement to include the contents of other source files (#include [once] "file") into the main source program." Works with classes (Types) too.

Only the called procedures will be added to the executable with the exception of procedures that are called by other procedures, ie. if procedure A is called by procedure B, the procedure A will be always included, even if your code does not call A or B. That is, if you neither call A and B, B won't be included, but A will be because it is called by B. An improvement to the compiler would be to also exclude A because it is being called by a procedure that is being excluded.
Last edited by Josep Roca on May 26, 2018 22:14, edited 1 time in total.
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 26, 2018 21:17

Thanks :-)
If you have other interesting details to highlight for this article, feel free to post them here.
coderJeff
Site Admin
Posts: 2614
Joined: Nov 04, 2005 14:23
Location: Ontario, Canada
Contact:

Re: Wiki improvements

Postby coderJeff » May 26, 2018 22:19

Josep Roca wrote:Only the called procedures will be added to the executable with the exception of procedures that are called by other procedures
Yes, see also, https://sourceforge.net/p/fbc/bugs/776/
fxm
Posts: 8173
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Wiki improvements

Postby fxm » May 27, 2018 9:43

About future article: How to Manage FB Reusable Procedures by Including Source Modules (vs. compiled modules)

Thank you both for this information, but other people can also provide me with interesting links on the subject or others.

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 1 guest