Project

General

Profile

Support #1751

Manual of functions vs ManExamples

Added by Anna Maria Bigatti 10 months ago. Updated 10 months ago.

Status:
In Progress
Priority:
Normal
Category:
-
Target version:
-
Start date:
03 Jul 2023
Due date:
% Done:

10%

Estimated time:

Description

In the manual we have things like these:

/**/  define fn(X)
/**/    assert(X > 0);
/**/    return FloorSqrt(X);
/**/  enddefine;

so that ManExamples can extract the input code.
Should we have something like
---- function definition ----
define fn(X)
  assert(X > 0);
  return FloorSqrt(X);
enddefine;
-----------------------------

(and the same for package) so that the manual looks more natural? (and with coloured syntax!)

History

#1 Updated by Anna Maria Bigatti 10 months ago

Look at the function

  void PrintExampleWithoutOutput(std::ostream &out, std::ifstream& in)

in OnlineHelp.C

Also available in: Atom PDF