Skip to content

Commit 50d29a0

Browse files
committed
neddoc: added content to simu5g-index.ned (incl version number and WHATSNEW page!)
1 parent 6145621 commit 50d29a0

2 files changed

Lines changed: 44 additions & 2 deletions

File tree

releng/makedist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ echo Creating $FILENAME_DOC.
3434
# switch to doc dir
3535
cd $SIMU5G_ROOT/doc
3636
# patching files
37-
#perl -i -pe $REGEXPREPLACE s/##BUILDID##/$BUILDID/g neddoc/overview.html
37+
sed -i -e "s/@VERSION@/$VERSION/g" neddoc/index.html
3838
# create archive
3939
tar cfz $FILENAME_DOC neddoc || { echo --- error creating simu5g-x.y.z-doc.tgz ---; exit 1;}
4040

src/simu5g/simu5g-index.ned

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,48 @@
88
//
99
// @titlepage
1010
//
11-
// <center><h1>Simu5G Framework NED Documentation</h1></center>
11+
// <center><h1>Simu5G-@VERSION@</h1></center>
12+
// <center><h3>NED Documentation<h3></center>
13+
//
14+
// Simu5G is an open-source simulation library for the OMNeT++ simulation
15+
// environment that extends the INET Framework with advanced 5G and LTE
16+
// modeling capabilities. It provides comprehensive models for researchers
17+
// and students working with 5G New Radio (NR), LTE-Advanced, and beyond-5G
18+
// communication systems. Simu5G is particularly useful for designing and
19+
// validating new 5G protocols, exploring advanced wireless scenarios, and
20+
// evaluating the performance of cellular networks.
21+
//
22+
// Simu5G supports a wide range of 5G and LTE features, including:
23+
// - <b>5G New Radio (NR):</b> Complete protocol stack with support for
24+
// mmWave communications, numerology, dual connectivity, and carrier aggregation
25+
// - <b>LTE/LTE-Advanced:</b> Full LTE protocol stack with advanced features
26+
// like D2D communication, multicast, multihop, and handover procedures
27+
// - <b>Multi-access Edge Computing (MEC):</b> ETSI MEC standard implementation
28+
// with service discovery, lifecycle management, and edge applications
29+
// - <b>Vehicular Communications:</b> V2X scenarios with realistic mobility
30+
// and channel models for connected and autonomous vehicles
31+
// - <b>Real-time Emulation:</b> Interface with real network equipment and
32+
// applications for hybrid simulation-emulation scenarios
33+
// - <b>Advanced Channel Models:</b> Realistic propagation models including
34+
// 3GPP-compliant channel models and mmWave-specific features
35+
// - <b>Background Traffic:</b> Scalable background cell and UE modeling
36+
// for large-scale network simulations
37+
//
38+
// Simu5G builds upon the solid foundation of the INET Framework, inheriting
39+
// its networking protocols (TCP, UDP, IPv4, IPv6, etc.) and extending them
40+
// with cellular-specific functionality. The framework supports node mobility,
41+
// advanced visualization through OMNeT++, and comprehensive statistics
42+
// collection for performance analysis.
43+
//
44+
// See the <tt><a href="whatsnew.html">WHATSNEW</a></tt> file in the distribution
45+
// for the list of recent changes and new features.
46+
//
47+
// @page whatsnew.html, What's New
48+
//
49+
// <pre>
50+
// <nohtml>
51+
// @include ../../WHATSNEW.md
52+
// </nohtml>
53+
// </pre>
1254

1355
package simu5g;

0 commit comments

Comments
 (0)