Getting Started with a minimal example

Table of Contents

1 Example

Prints all documented items, except those tagged with "Internal"

Index: [A] Alpha [P] Point [n] norm

  • Alpha
@enum Alpha A=1 B C 

An enum

Foo.jl:31, back to index

  • Point
struct Point

This is my Point structure

Example:

Creates a point \(p\) of coordinates \((x=1,y=2)\).

p=Point(1,2)

You can add any valid Org mode directive. If you want to use in-documentation link, use norm(…)

Foo.jl:8, back to index

Point()

Creates Point at origin \((0,0)\)

Foo.jl:27, back to index

  • norm
norm(p::Point)::Float64

A simple function that computes \(\sqrt{x^2+y^2}\)

Example:

p=Point(1.0,2.0);
norm(p) 
***ERROR***  UndefVarError(:norm)

See: struct Point

Foo.jl:35, back to index

Author: picaud

Created: 2019-01-11 Fri 18:17

Validate