assets/developer-notes/stephanie-gawroriski/2016/09/12.mkd

   1 # 2016/09/12
   2
   3 ## 12:38
   4
   5 The next version of fossil is going to have unversioned files. This is a
   6 feature that I have been waiting for quite some time for. Basically it is
   7 similar to the Wiki except that it is not versioned. This means that starting
   8 with the next version of fossil I can have JavaDoc in my fossil repoository
   9 and I can keep it autogenerated via script.
  10
  11 ## 12:43
  12
  13 This will be very awesome indeed. I suppose what I should do is create a doclet
  14 that outputs to a deterministic markdown format, so that if the source code
  15 changes it produces the same document. One issue though would be links to
  16 individual methods.
  17
  18 ## 12:50
  19
  20 I do wonder though if I should merge it so all projects are considered as one
  21 or create documentation for individual projects. One thing though is that the
  22 script that performs this will be a bit complex. I have to generate the JavaDoc
  23 tree and then go through the fossil unversioned tree and determine which files
  24 have been added or removed. I would need to sort both outputs, then when
  25 going through each file perform a checksum on it to see if it differs at all.
  26 If it does differ then it changes. At least using markdown, the actual output
  27 files will be much simpler to read using even simple `less`.
  28
  29 ## 12:57
  30
  31 I should keep the JavaDoc generated sources in its own directory so that it
  32 does not mess with anything else. I suppose I can generate it on a daily basis
  33 and sync it so that it is up to date. I would keep the script that does it in
  34 the repository so that it is versioned and so if I ever migrate systems and
  35 such I do not lose the script.
  36
  37 ## 15:05
  38
  39 The unversioned files could also have stuff such as videos about SquirrelJME,
  40 screenshots, and other things. Although that may bloat the repository a bit.
  41