Inheritance documentation

Forum for discussion about the documentation project.
counting_pine
Site Admin
Posts: 5904
Joined: Jul 05, 2005 17:32
Location: Manchester, Lancs

Re: Inheritance documentation

Postby counting_pine » Mar 20, 2013 17:57

We have two potential solutions to this problem that don't involve appending Sleep to every example:
- Provide the expected output of the program after the code, or in well-placed comments in the code
- Provide an informal Getting Started guide, linked to from the main page, that covers issues like how to keep the program window open.

There are several methods for this, be it IDE settings, appending Sleep/Shell "pause", including a file containing a module destructor, etc. It may warrant a page of its own, linked to from the aforementioned hypothetical informal guide. As long as new people understand what is going on and how to overcome it, that's the main thing.
(Not sure what we'd call the page though..)
TJF
Posts: 3329
Joined: Dec 06, 2009 22:27
Location: N47°, E15°

Re: Inheritance documentation

Postby TJF » Mar 21, 2013 7:33

counting_pine wrote:It keeps the program open without hinting why.

IMHO this is not acceptable.

counting_pine wrote:- Provide the expected output of the program after the code, or in well-placed comments in the code

This is my prefered solution.
  • The reader can check if the example meets his needs without downloading / compiling any code.
  • The example author can generate the (text) output with low effort.
counting_pine
Site Admin
Posts: 5904
Joined: Jul 05, 2005 17:32
Location: Manchester, Lancs

Re: Inheritance documentation

Postby counting_pine » Mar 21, 2013 18:17

The two methods aren't mutually exclusive though.. I think we could do with a general Getting Started guide - taking a quick look, the closest I can find is ProPgHelloWorld in the Programmer's Guide or TutGettingStartedQB in Community Tutorials. Neither are particularly obvious from the front page, and the Community Tutorials are often out of date or "unofficial", and have never really been checked through.
fxm
Posts: 7901
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: Inheritance documentation

Postby fxm » Jul 27, 2017 6:05

Added in the Glossary the definitions of:
- inheritance (TYPE or CLASS)
- object (built-in TYPE or CLASS)
- RTTI
- virtual member function
- abstract member function
- override
- polymorphism (TYPE or CLASS)
- covariance (TYPE or CLASS)
- contravariance (TYPE or CLASS)
- invariance (TYPE or CLASS)

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 1 guest