JinnIde - JinniDoc's Known Bugs

JinnIde is the Jinni Prolog IDE Plugin for JEdit. The initial release of its automated documentation system has a couple of minor bugs which one might want to be aware of or look up here or on Sourceforge's JinniPlugin site. Please use Sourceforge's bug tracking system for the Jinni Prolog IDE Plugin should you want to tell me about other possible bugs.

• " are not supported in the @descr part. use ' instead
• in certain situations letters might be eliminated, which is the so-called bitten letter bug. It always occurs when the predicate definition does not seem to appear with a carriage return ahead. So as a workaround for this occurrence of the bitten letter bug simply always include a CR as a prefix for whatever predicate definition
• there are a couple of characters missing or instead used on other terminals than windows wich confuse JinniDoc in a way that causes the bitten letter bug to appear even with a repetition of the same predicate without a bitten letter. As an intermediate solution you can make such a file JinniDoc compliant by simply opening it in Wordpad, inserting and deleting a space character and then resaving the file.
• heavy size bug: when the description in @descr is too large (an example for this is given in the old loq.pro which is quoted in the following), a recursion overflow "copy_term warning: recursion overflow, returned: $null" occurs. The problem is NOT in translateComments but in the parsing done after translateComments is finished.
• FIXED(in Cassandra release): the +,-,? indications for the parameters of a predicate do not always seem to work correctly. See loq.htmll for an example. Somehow at most only one parameter is indicated, the others are left.

JinnIde - Known Jinni Prolog Bugs

• Jinni Prolog memory leak bug: it has been observed that Jinni Prolog sometimes keeps losing memory e.g. when JinniDoc is documenting a larger file or a directory; this memory is not reclaimed and is left, used up, as a burden on the system. There are two ways to work around this issue: Use the Jinni Prolog Server by ticking the server box in the JinnIde menu or by setting it up for all JinnIde sessions, see JinnIde Server Setup for details. Then you can restart it to close the server's leak. Otherwise, when using the embedded engine the only option is to restart JEdit/JinnIde. The second way is to wait for a while, because it has also been observed that the JinnIde server is able to release its unused memory after some time. The memory leak bug is supposed to be resolved in future Jinni Prolog releases.
• Jinni Prolog file lock bug: when a class or a module is created as an object instance it may happen that the corresponding file is locked by Jinni Prolog so that any kind of save operation through JEdit quits with an I/O write failure; when the embedded engine is used, the only workaround for this is to call JinnIde's reset function (see the JinnIde menu) several times (usually a dozen times..) until the lock is released. Otherwise, prefer the server engine because it allows restarting it whenever desired.
• Jinni Prolog classpath bug: when creating a new project or a new package it may happen that the newly acquired classpaths, although properly introduced in Jinni Prolog's classpath setting - e.g. check it with path_element(D) - are somehow ignored and new classes or modules are thus ignored as well; there is no other workaround for that than using another classpath until this matter is resolved by a future Jinni Prolog release