HaxeDoc2

(やまだぃちぅ) #1

Todo list


Could we have a big Haxe logo in the First Manual Page (Introduction) under the menu (a
bit like a book cover ?) It looks a bit empty now and is a landing page for ”Manual”. 7
This generates the following output: too many ’this’. You may like a passive sentence: the
following output will be generated...though this is to be avoided, generally ...... 9
make sure the types are right for inc, dec, negate, and bitwise negate ............. 13
While introducing the different operations, we should include that information as well, in-
cluding how they differ with the ”C” standard, see http://haxe.org/manual/operators 13
please review, doubled content ................................... 15
review please, sounds weird..................................... 15
for starters...please review ...................................... 16
Is there a difference between?y : Intandy : Nullor can you even do the
latter? Some more explanation and examples with native optional and Haxe optional
arguments and how they relate to nullability would be nice. ............... 17
please review future tense ...................................... 17
Same as in 2.2, what isEnumsyntax? ............................. 20
list arguments ............................................. 20
please reformat ............................................ 22
I don’t really know how these work yet. .............................. 24
It seems a bit convoluted explanations. Should we maybe start by ”decoding” the meaning
of Void -¿ Void, then Int -¿ Bool -¿ Float, then maybe have samples using $type .... 24
please review your use of “this” and try to vary somewhat to avoid too much word repetition 31
please review for correctness..................................... 34
You have marked “Map” for some reason ............................. 34
Mention toString()/String conversion somewhere in this chapter. ............... 46
”parent class” should probably be used here, but I have no idea what it means, so I will
refrain from changing it myself................................. 47
Describe import a.* .......................................... 53
proper label and caption + code/identifier styling for diagram................. 53
Figure out wtf our rules are now for when this is checked. ................... 86
Comprehensions are only listing Arrays, not Maps........................ 87
what to use for listing of non-haxe code like hxml?........................ 98
Check if we can build GADTs this way................................ 109
I think C++ can use integer operatins, but I don’t know about any other targets. Only saw
this mentioned in an old discussion thread, still true? ................... 124

Free download pdf