Re: make doxygen on java

[Carnë Draug]

On 3 August 2016 at 21:26, Ernst Reissner <address@hidden> wrote:
> On 08/03/2016 08:55 PM, Carnë Draug wrote:
>> On 3 August 2016 at 17:42, Ernst Reissner <address@hidden> wrote:
>>> On 08/03/2016 05:49 PM, Carnë Draug wrote:
>>>> On 3 August 2016 at 10:28, Ernst Reissner <address@hidden> wrote:
>>>>> Hi all,
>>>>>
>>>>> I try to produce doxygen comments.
>>>>>
>>>>> To check whether all links are ok, I would like to try sth like make doc
>>>>>
>>>>> but i cannot find the according makefile..
>>>>>
>>>>> I build in .build.
>>>>>
>>>> Hi Ernst
>>>>
>>>> Nice to see more people working on that.  Use "make doxyhtml" as mentioned
>>>> in 
>>>> http://hg.savannah.gnu.org/hgweb/octave/file/46b67f1569b5/doc/doxyhtml/README
>>>>
>>>> Carnë
>>>>
>>> Thank you Carne,
>>> I just documented java-sources in scripts/java/org/octave/
>>> But no output reached html....
>>>
>>> Sth to be added to the makefiles???
>>>
>> I didn't realize you were trying to write docs for that.  I thought you
>> were documenting ov-java.  The java classes in org.octave are not really
>> exposed anywhere so I'm not sure it makes sense to have them on the public
>> doxygen docs.
>>
>> Actually, why do we even have those classes?  Can't we use the JNI and
>> have everything in C++ in ov-java.cc?
>>
> I think, ov-java is merely a wrapper around the java classes.
>
> I would say, these are the core.
>
> I think the lot of reflection is difficult to reimplement in c++ and
> also, this makes no sense.
>
> I would appreciate to have these classes documented.
>
> We have c++ documented, also m-files, why not java?

As long as it's clear that java code is not meant to be used outside of
Octave, it's fine.  We also don't publicly document private m files.
There's documentation for them, but it's not side by side with the help
text for the m files implementing public functions.  But I guess doxygen
docs are different so go for it.

Carnë