Skip to content

Commit

Permalink
core: fix html errors in the javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Khoyo committed Nov 25, 2022
1 parent e8e0790 commit 16baacb
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class UnavailableSpaceBuilder {
* This considers existing occupancy blocks, the length of the train,
* and the routes that must be left available behind the train
*
* </p>
* <br/>
* This is the first step to compute STDCM, the goal is to get rid of railway rules and extra complexity
* as soon as possible. After this step we can look for a single curve that avoids unavailable blocks. */
public static Multimap<SignalingRoute, OccupancyBlock> computeUnavailableSpace(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
/** This class contains all the methods used to backtrack in the graph.
* We need to backtrack to remove any kind of speed discontinuity, generally because of deceleration spanning over
* several edges.
* </p>
* <br/>
* A short explanation of how it's done: given nodes a, b, c, d
* If we compute the edge "c->d" and see that we need to go slower at the start of the node (e.g. because we stop here)
* We instantiate a new edge going from b to c, with the specified end speed. The predecessor of this new "b->c" edge
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ static EnvelopeSimContext makeSimContext(

/** Returns an envelope matching the given route. The envelope time starts when the train enters the route.
*
* </p>
* <p>
* Note: there are some approximations made here as we only "see" the tracks on the given routes.
* We are missing slopes and speed limits from earlier in the path.
* </p>
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/fr/sncf/osrd/envelope/package-info.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* <h1>Envelopes</h1>
* Envelopes
* <h2>Overview</h2>
* <p>Envelopes are a framework for working with position / speed curves, with constant acceleration between each point.
* This isn't as simple as it may seem, as acceleration works over time, and the envelopes work over space.</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* <h1>Envelope Sim</h1>
* Envelope Sim
* <p>Envelope sim is a library to run simulations over envelopes.</p>
* <p>It can be used independently from the rest of the project.</p>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

/** An oriented view on a track range. Can be used to iterate over its content */
public class TrackRangeView {
/** Start of the range on the original undirected track (begin < end) */
/** Start of the range on the original undirected track (begin &lt; end) */
public final double begin;
/** End of the range on the original undirected track (begin < end) */
/** End of the range on the original undirected track (begin &lt; end) */
public final double end;
/** Referenced oriented track. This sets the direction of the range */
public final DiTrackEdge track;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ public static <T> List<T> removeLocation(ImmutableList<LocatedElement<T>> list)
.collect(Collectors.toList());
}

/** Utility function, returns the last element with offset <= the given offset.
/** Utility function, returns the last element with offset &lt;= the given offset.
* For range objects (route / sections), it returns the element containing the offset. */
public static <T> T getLastElementBefore(ImmutableList<LocatedElement<T>> list, double offset) {
return getLastLocatedElementBefore(list, offset).element;
}

/** Utility function, returns the last located element with offset <= the given offset.
/** Utility function, returns the last located element with offset &lt;= the given offset.
* For range objects (route / sections), it returns the element containing the offset. */
public static <T> LocatedElement<T> getLastLocatedElementBefore(
ImmutableList<LocatedElement<T>> list,
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/fr/sncf/osrd/package-info.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* <h1>The core OSRD module</h1>
* The core OSRD module
*
* <p>Reading through a log file gives a good overview of how the project works:</p>
* <ul>
Expand Down

0 comments on commit 16baacb

Please sign in to comment.