Commit Graph

281 Commits

Author SHA1 Message Date
Tristan B. Velloza Kildaire 5deb4f9249
Feature/modman (#2)
* Parsing

- (WIP) Adding information about the module manager sub-system

* Parsing

- Added some stuff (stashing it up)

* MK

* Parsing

- Updated header type

* Parsing

- Update

* Small docs transferred in

* ModMan

- Fixed up formatting - now it builds right

* Updates

* Docs

- Updated

* Resolver

- Updated docs

* Updated docs

* Resolver Docs

- Updated with more information

* Resolver

- Added more docs

* Resolver docs

- Updated

* Resolver docs

- Fixed run-on-lines

* Resolver docs

- Fixed run onlines

* Resolver docs

- Fixed run onlines

* Docs

- Updated

* Docs

- Fixed run over lines

* Resolver docs

- Updated

* Resolver Docs

- Added code example

* Small docs

- Added code insertion

* Config

- Updated docs

* Modules

- Added note on file naming
- Added TODO section

* Command-line

- Added information about `--paths`

* Config

- Added information about the `modman:paths` configuration option

* Language usage

- Documentation added

* Command-line

- Formatting fixed

* Parser

- Work-in-progress for the importing system

* Parser

- Added steps + code example

* Parsing

- More documentation on multi odule added

* Parser

- Updated docs

* Graphs

- Updated

* Parsing

- Added notes on parsing, all done now
2024-04-08 12:45:17 +02:00
Tristan B. Velloza Kildaire e182b6ee00
Feature: Lexer improvements (#3)
* Grammar

- Updated grammar for the numbers formatting

* Grammar

- Aligned `::=`

* Generate

- Updated markdown

* Lexer

- Added character constants source code listing

* Lexical

- Typo fix

* Generated

* Lexical analysis

- Added a section on "Character constants"
- Added a section on "Helper methods"

* Lexical analysis

- Added missing method

* Lexical analysis

- Removed old section on `isSpliter()`
- Removed the old "Others" section
- Documented the Grammar-wise methods

* Lexical analysis

- Documented the buffer management methods

* Lexical analysis

- Removed `stringMode` and `floatMode`

* Lexical analysis

- Documented `LexerException`
- Documented `LexerError`

* Lexical analysis

- Added missing grammar link

* Lexical analysis

- Fixed grammar link

* Lexical analysis

- Removed last TODO
- Fixed typo

* Generated

- Pandoc plot

* Lexical analysis

- Updated heading
- Changed header sizes
2023-12-27 08:24:19 +02:00
Tristan B. Velloza Kildaire 85837645bd Revert "Mkdocs"
This reverts commit 9374c4fce7.
2023-12-22 17:42:32 +02:00
Tristan B. Velloza Kildaire 571215db7c Scripts
- Added a script which outputs to a `$1`
2023-12-20 20:08:22 +02:00
Tristan B. Velloza Kildaire 9374c4fce7 Mkdocs
- Removed old plugins
2023-12-20 19:51:22 +02:00
Tristan B. Velloza Kildaire 2c0ff313f9 Mkdocs
- Disabled that
2023-12-20 19:49:02 +02:00
Tristan B. Velloza Kildaire be9ed17d99
Feature/unused vars (#1)
* TypeChecker

- Adding new chapter `Variable referencing counting`

* TypeChecker

- Added missing method table
- Added code usage

* Markdown transform

- Updated

* Configuration

- Documented `typecheck:warnUnusedVars`

* Command line

- Added compiler flags documentation

* MK

- Built

* Command line

- Formatting fixed

* MK

- Built
2023-11-05 17:25:05 +02:00
Tristan B. Velloza Kildaire 99c10d4953 Confuguration
- Typo fixes
2023-11-05 17:10:51 +02:00
Tristan B. Velloza Kildaire 17dc8ad698 Grammar
- Typo fix
2023-11-05 16:44:02 +02:00
Tristan B. Velloza Kildaire e9e04da11c Naming
- Added `...`
2023-08-27 11:38:28 +02:00
Tristan B. Velloza Kildaire d9ca5f6dd5 Naming
- Built
2023-08-20 22:50:11 +02:00
Tristan B. Velloza Kildaire a7dc8e7037 Naming
- Added information on how to use the `findContainerOfType(TypeInfo_Class containerType, Statement startingNode)` method from the `Resolver`
2023-08-20 22:50:00 +02:00
Tristan B. Velloza Kildaire a008759f49 Naming
- Added usage of `resolveBest(Container, string)`
- Added a note about the meaning of `null` returned by look up methods
2023-08-20 22:25:56 +02:00
Tristan B. Velloza Kildaire 2b31ca374d Naming
- Added more methods to the method table for `Resolver`
2023-08-20 17:01:47 +02:00
Tristan B. Velloza Kildaire 7c11f674a3 Naming
- Added a method table with some methods
- Built docs otu
2023-08-20 16:15:46 +02:00
Tristan B. Velloza Kildaire 52bd0ed3e3 Naming
- Wrote an overview of the system
2023-08-20 15:58:31 +02:00
Tristan B. Velloza Kildaire 6674c67674 Grammar
- Updated stuff

Configuration

- Updated information about `dgen` flags
2023-08-16 16:21:15 +02:00
Tristan B. Velloza Kildaire 7155cb9b77 Meta processing
- Finished describing the process of "Macro replacement"
2023-07-09 21:33:56 +02:00
Tristan B. Velloza Kildaire ea24f05e8b Compiler
- Added meta processing to the pipeline diagram
2023-07-09 21:24:32 +02:00
Tristan B. Velloza Kildaire 43ba83e163 Meta processor
- Added some introduction notes to the "Macro replacement" section
2023-07-09 21:11:26 +02:00
Tristan B. Velloza Kildaire 75f3f0b70d - Added notes on contributing 2023-07-09 21:11:04 +02:00
Tristan B. Velloza Kildaire c073fb5eb4 Meta processing
- Updated title levels used
2023-07-09 21:03:46 +02:00
Tristan B. Velloza Kildaire a09536cdce MetaProcessor
- Added remaining methods for the `MetaProcessor`
- Added information about the usage of `getConcreteType(string)` in the "Type alias replacement" section
2023-07-09 20:58:37 +02:00
Tristan B. Velloza Kildaire 15862f4443 Meta processor
- Described the process of AST processing (so far)
- Added method table containing methods from the `MetaProcessor`
- Added section describing what `doTypeAlias(Container, Statement)` does
2023-07-09 20:47:03 +02:00
Tristan B. Velloza Kildaire 49779c6245 Meta processor
- Described the role (via some examples) of the meta processor
2023-07-09 20:29:17 +02:00
Tristan B. Velloza Kildaire 3d463ff1e7 Meta
- Added title for next section
- Added path for Meta API definitions
2023-07-09 17:50:45 +02:00
Tristan B. Velloza Kildaire 1354fd2b08 Meta API
- Documented some parts of the Meta API including `MStatementSearchable`, `MStatementReplaceable`, `MTypeRewritable` and `MCloneable`
2023-07-09 17:47:53 +02:00
Tristan B. Velloza Kildaire 95c6aa65ea Types
- Deleted conflict files
2023-07-09 16:58:30 +02:00
Tristan B. Velloza Kildaire 5cee6220b3 Ya 2023-07-09 16:55:23 +02:00
Tristan B. Velloza Kildaire 02729f8b20 Lexical
- Added TODO table for the remaining methods
2023-07-09 16:53:22 +02:00
Tristan B. Velloza Kildaire bf37603077 Lexical
- Changed to table formatting
2023-07-09 16:44:54 +02:00
Tristan B. Velloza Kildaire 1eb58a4bf3 Lexical
- Added example usage of the `BasicLexer`
2023-07-09 16:39:51 +02:00
Tristan B. Velloza Kildaire 4e7867ef59 Lexical
- Re-worked the `BasixLexer` part
- Added table of fields that make up the `BasicLexer` along with explanations
2023-07-09 16:34:40 +02:00
Tristan B. Velloza Kildaire 0b069ac857 Lexical
- Re-did the documentation of the `Token` API to use a table for listing the methods
2023-07-09 16:16:31 +02:00
Tristan B. Velloza Kildaire 7b3bee59f1 Lexical
- Documented the `LexerInterface`'s methods (its API)
2023-07-09 16:06:32 +02:00
Tristan B. Velloza Kildaire 2a015a60bb TypeChecking
- Fixed some typos here and there
2023-07-09 15:50:34 +02:00
Tristan B. Velloza Kildaire 2a83a653d5 TypeChecking
- Remoevd now-completed TODO
- Typo fix
2023-07-09 14:57:01 +02:00
Tristan B. Velloza Kildaire e690dc9619 TypeChecking
- Improved formatting of code example
2023-07-09 14:56:05 +02:00
Tristan B. Velloza Kildaire ff87a36951 TypeChecking
- Added an example of the `typeEnforce()` being used for coercion
2023-07-09 14:55:24 +02:00
Tristan B. Velloza Kildaire 3403fd7381 TypeChecking
- Fixed overflow of code in example, formatting to not cross margins
2023-07-09 14:39:00 +02:00
Tristan B. Velloza Kildaire 0b3ed41e5c TypeChecker
- Explained how the coercion works as part of `typeEnforce()`
2023-07-08 12:33:10 +02:00
Tristan B. Velloza Kildaire 9e0e2a04c9 Post-proc 2023-07-08 12:19:03 +02:00
Tristan B. Velloza Kildaire 6004a429d3 Typechecking
- Documented exact types or type equality
2023-07-08 12:18:42 +02:00
Tristan B. Velloza Kildaire 07fca41966 TypeChecking
- Cleaned up stray elements
2023-07-08 12:04:18 +02:00
Tristan B. Velloza Kildaire 6d0750cf73 TypeChecking
- Added the mathematics behind the coercion function
2023-07-08 11:55:56 +02:00
Tristan B. Velloza Kildaire ae9cf2de84 Merge branch 'master' of github.com:tbklang/documentation 2023-07-08 11:46:25 +02:00
Tristan B. Velloza Kildaire 78cf4d2459 TypeChecking
- Added a TODO
2023-07-08 11:46:09 +02:00
Tristan B. Velloza Kildaire d60094f307 - Added `.gitignore` 2023-07-08 11:45:16 +02:00
Tristan B. Velloza Kildaire f49285eb87 Types
- Added type alises
2023-07-08 11:45:09 +02:00
Tristan B. Velloza Kildaire b169eb6d2e Post-process add 2023-07-07 22:45:52 +02:00