URLs for specific API commands

[SafwatHalaby]

Commit id: f7029ed

When visiting http://api-docs.cuberite.org, I'd want to have links to individual commands via the hash part of the URL. e.g. http://api-docs.cuberite.org/cPlayer.html#Freeze Should lead to the player class's Freeze command.

This should be rather simple: Each command's first HTML table cell, <td>X</td> should be changed to:

<td id="X">
  <a href="PageURL#X">X</a>
</td>

Better methods are welcome.
This may require changes to the built in APIDump plugin, which is why I posted it here.

[NiLSPACE]

Shouldn't be too hard to do. Just add an anker tag here: https://github.com/cuberite/cuberite/blob/master/Server/Plugins/APIDump/main_APIDump.lua#L786

[Seadragon91]

@LogicParrot Very nice idea :)

@NiLSPACE Found 2 more places where it has to be added. For constants and also for member variables.

This are the changes that I tested and they works,
Seadragon91@9678051

[madmaxoft]

Careful, though. Do we want to simply mix all the symbols together (functions, constants, variables, enums) in this way, or should we prefix the anchor with something? Such as Fn<Name><OverloadIndex>? That way you could even link to a specific overload (parameter combination) of the function, in case it has more.

[madmaxoft]

@Seadragon91 I don't think that's how anchoring works, AFAIK you need to use <a name="FunctionName">content</a>

[bearbin]

@madmaxoft No, it does work like that, # can link to IDs. For an example, see https://book.cuberite.org

[madmaxoft]

Hmm, I guess I'm too old-school :P

[madmaxoft]

Then either convert all the anchors in the APIDump plugin output to use this syntax, or use the old one. Be consistent.

[Pokechu22]

<a name=""> is obsolete syntax in HTML5 and id should be used instead.

[Seadragon91]

I added a table to track the function names and add _<number> to the anchor name for the overloaded functions. Also added a title, if the mouse hover over it.
Has anyone a better idea for unique anchor names, or does this fit?

Seadragon91@7a3763a

Edit:
Example of the anchor names

1. MoveToWorld
2. MoveToWorld_2
3. MoveToWorld_3

[madmaxoft]

Drop the if, use TableOverloadedFunctions[func.Name] = (TableOverloadedFunctions[func.Name] or 0) + 1 and get the first overload numbered as well as a bonus :)

[Seadragon91]

This would then add a _1 for all functions. Is that okay?

Edit: Or I copy the loop and create the table beforehand and use it then in the write loop.
Edit 2: Forget the first edit :)

[madmaxoft]

It will number the functions incrementally

[Seadragon91]

Yes it will increment it, but I mean that now all functions that are not overloaded will have the _<number>.

[madmaxoft]

Yes, all the anchors will have the same format, rather than having two different formats. And if a function ever receives an overload, its anchored link will still work afterwards.