better documentation

Author: wadoon

keyext.api.doc/src/main/java/org/key_project/key/api/doc/DocGen.java

@@ -3,20 +3,21 @@
  * SPDX-License-Identifier: GPL-2.0-only */
 package org.key_project.key.api.doc;
 
-import java.io.IOException;
-import java.io.StringWriter;
-import java.util.Comparator;
-import java.util.Map;
-import java.util.TreeMap;
-import java.util.function.Supplier;
-
+import de.uka.ilkd.key.util.KeYConstants;
+import de.uka.ilkd.key.util.KeYResourceManager;
 import freemarker.core.HTMLOutputFormat;
 import freemarker.ext.beans.ZeroArgumentNonVoidMethodPolicy;
 import freemarker.template.Configuration;
 import freemarker.template.DefaultObjectWrapper;
 import freemarker.template.TemplateException;
 import freemarker.template.TemplateExceptionHandler;
 
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.*;
+import java.util.function.Supplier;
+import java.util.stream.Collectors;
+
 /**
  * Generation of Markdown documentation.
  *
@@ -49,7 +50,7 @@ public String get() {
             wrapper.setExposeFields(true);
             wrapper.setMethodsShadowItems(true);
             wrapper.setRecordZeroArgumentNonVoidMethodPolicy(
-                ZeroArgumentNonVoidMethodPolicy.BOTH_METHOD_AND_PROPERTY_UNLESS_BEAN_PROPERTY_READ_METHOD);
+                    ZeroArgumentNonVoidMethodPolicy.BOTH_METHOD_AND_PROPERTY_UNLESS_BEAN_PROPERTY_READ_METHOD);
             wrapper.setForceLegacyNonListCollections(false);
             wrapper.setDefaultDateType(freemarker.template.TemplateDateModel.DATETIME);
             cfg.setObjectWrapper(wrapper);
@@ -60,15 +61,25 @@ public String get() {
             model.put("segmentDocumentation", metamodel.segmentDocumentation());
 
             model.put("endpoints",
-                metamodel.endpoints()
-                        .stream().sorted(Comparator.comparing(Metamodel.Endpoint::name))
-                        .toList());
+                    metamodel.endpoints()
+                            .stream().sorted(Comparator.comparing(Metamodel.Endpoint::name))
+                            .toList());
+
+            final Map<String, List<Metamodel.Endpoint>> collect = metamodel.endpoints()
+                    .stream().sorted(Comparator.comparing(Metamodel.Endpoint::name))
+                    .collect(Collectors.groupingBy(Metamodel.Endpoint::segment, TreeMap::new, Collectors.toList()));
+
+            model.put("endpointsBySegment", collect);
 
             model.put("types",
-                metamodel.types().values()
-                        .stream().sorted(Comparator.comparing(Metamodel.Type::name))
-                        .toList());
+                    metamodel.types().values()
+                            .stream().sorted(Comparator.comparing(Metamodel.Type::name))
+                            .toList());
 
+            model.put("version",
+                    KeYResourceManager.getManager().getVersion() +
+                            " (" + KeYConstants.INTERNAL_VERSION.substring(0, 8) + ")");
+            model.put("date", new Date());
 
             // 3) Get template
             var tpl = cfg.getTemplate("docs.ftl");