When I finally get this mess working:
You will be able to do this:
flx p.flx
flx p.fdoc
flx p
The first two are obvious: "flx" can now process an fdoc file directly.
The file starts with Felix code, and a @ at the start of a line starts a
comment,
except on line 1, so in *.fdoc files start with a blank line please. An @felix
line reverts to
parsing code. The @ stuff is the same in *.flx and *.fdoc. From the compiler
viewpoint
these two layouts are identical. however he webserver uses the extension to
control
the layout, and currently can NOT handle @ comments in Felix code. Just use an
fdoc file instead.
In the last command, flx tries to find BOTH p.flx and p.fdoc and uses the
latest one.
This will happen even if they're in different directories!
The effect of this at present is that flx can run the tutorial examples in
nutut directly.
no need to flx_tangle to extract the embedded Felix. However that's still needed
to get the expected test output.
The mechanism above should with with
include "base";
directives too: it will find the latest of base.fdoc, base.flx in the search
path.
The effect is you can write *.flx files, or you can write *.fdoc files if and
or when
you want quality documentation.
The other effect is that I can replace, one file at a time, the standard
library *.flx
files with *.fdoc ones, and thus document the library with extensive well
formatted
documentation which is tied by textual locality to the code being documented.
I may also add some more "sexy" commands in fdoc format. For example
@class myclass[T]
in Felix would start a class which ends at the end of file. Saves on the
trailing }
mark, and, it tells fdoc processing to index the class somehow.
In particular for library classes it would be useful to put unit tests
directly in the files, for the same reason we want the docs in the files:
so we can maintain them.
Enjoy! :-)
--
john skaller
skal...@users.sourceforge.net
http://felix-lang.org
------------------------------------------------------------------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnmore_123012
_______________________________________________
Felix-language mailing list
Felix-language@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/felix-language
