mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Connor Doyle" <con...@mesosphere.io>
Subject Re: Review Request 35961: Include protobuf classes in generated Javadoc.
Date Mon, 29 Jun 2015 15:42:51 GMT


> On June 27, 2015, 6:59 p.m., Adam B wrote:
> > src/java/generated/org/apache/mesos/MesosNativeLibrary.java.in, lines 27-36
> > <https://reviews.apache.org/r/35961/diff/1/?file=993816#file993816line27>
> >
> >     Did you verify that the curly-braces are properly handled here? I read on http://stackoverflow.com/a/13512524/4056606
that the `{@code` tag will interpret the first closing brace as its own ending brace. In fact,
@code may only be necessary for wrapping Generic `<something>` declarations. You could
additionally/instead use the old-style `<code>` tag to print everything in code-font.
I would hope this would be easier, but parsing code within docs within code must be difficult.
Don't even try to put `/*` block comments inside your code example, or the compiler will get
confused too.

Yes, it does seem to work.  Here is the output as rendered by my up-to-date Google Chrome
browser on OS X:

[![Rendered code block.](http://s15.postimg.org/p44aqh2e2/Screen_Shot_2015_06_29_at_07_47_24.jpg)](http://s15.postimg.org/p44aqh2e2/Screen_Shot_2015_06_29_at_07_47_24.jpg)

However, I personally find the `<code></code>` markup more readable than the dangling
closing curling brace.  I will update this to use the plain HTML tag style.


> On June 27, 2015, 6:59 p.m., Adam B wrote:
> > src/java/mesos.pom.in, line 134
> > <https://reviews.apache.org/r/35961/diff/1/?file=993817#file993817line134>
> >
> >     Is `${project.basedir}/generated` any better/different than `@abs_top_builddir@/src/java/generated`

Probably not, will update to use `@abs_top_builddir@` instead.


> On June 27, 2015, 6:59 p.m., Adam B wrote:
> > src/java/src/org/apache/mesos/MesosExecutorDriver.java, line 31
> > <https://reviews.apache.org/r/35961/diff/1/?file=993818#file993818line31>
> >
> >     Oracle docs (and wikipedia) claim that javadoc only uses the opening <p>
tag, without the closing </p> tag. Did you find that this rendered incorrectly?

Good point.  I ran the build with JAVA_HOME pointing to Java 8, which is much more stringent
regarding Javadoc errors.  Without this change, the build actually fails with Java 8.  I will
verify that this still works with Java < 8.


- Connor


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/35961/#review89629
-----------------------------------------------------------


On June 27, 2015, 1:18 a.m., Connor Doyle wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/35961/
> -----------------------------------------------------------
> 
> (Updated June 27, 2015, 1:18 a.m.)
> 
> 
> Review request for mesos, Adam B and Ben Whitehead.
> 
> 
> Bugs: MESOS-1552
>     https://issues.apache.org/jira/browse/MESOS-1552
> 
> 
> Repository: mesos-incubating
> 
> 
> Description
> -------
> 
> Updates the Java POM to include the generated Java protobuf classes.
> 
> 
> Diffs
> -----
> 
>   src/java/generated/org/apache/mesos/MesosNativeLibrary.java.in c54d903 
>   src/java/mesos.pom.in 138da55 
>   src/java/src/org/apache/mesos/MesosExecutorDriver.java 1b5ed60 
> 
> Diff: https://reviews.apache.org/r/35961/diff/
> 
> 
> Testing
> -------
> 
> - configure
> - make
> - Manual verification of generated Javadoc HTML
> 
> 
> Thanks,
> 
> Connor Doyle
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message