Extern/Beef
1
0
Fork 0
mirror of https://github.com/beefytech/Beef.git synced 2025-06-08 11:38:21 +02:00
Code Activity

add expanded documentation info upon hovering over a function

Browse source
This commit is contained in:
Fraser 2025-05-26 15:12:07 +10:00
parent ba4d29d28d
commit bd333e5e67
2 changed files with 115 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

70
IDE/src/ui/AutoComplete.bf
View file

@ -17,6 +17,13 @@ namespace IDE.ui
{
public String mDocString = new String(256) ~ delete _;
public String mBriefString ~ delete _;
public String mAuthorString ~ delete _;
public String mReturnString ~ delete _;
public String mRemarksString ~ delete _;
public String mNoteString ~ delete _;
public String mTODOString ~ delete _;
public String mSeeAlsoString ~ delete _;
public String mVersionString ~ delete _;
public Dictionary<String, String> mParamInfo ~ DeleteDictionaryAndKeysAndValues!(_);
public String ShowDocString
@ -37,6 +44,24 @@ namespace IDE.ui
bool lineHadContent = false;
String curDocStr = null;
// Helper function to support adding various documentation strings without bloating code size
[System.Inline]
void AddPragma(ref String resultString, StringView pragma, StringSplitEnumerator splitEnum)
{
if (resultString == null)
resultString = new String(pragma.Length);
else if (resultString != null)
{
if (!resultString[resultString.Length - 1].IsWhiteSpace)
resultString.Append(" ");
}
var briefStr = StringView(pragma, splitEnum.MatchPos + 1);
briefStr.Trim();
resultString.Append(briefStr);
curDocStr = resultString;
lineHadContent = true;
}
for (int idx = 0; idx < info.Length; idx++)
{
char8 c = info[idx];
@ -128,24 +153,43 @@ namespace IDE.ui
if (mParamInfo == null)
mParamInfo = new .();
curDocStr = new String(pragma, Math.Min(splitEnum.MatchPos + 1, pragma.Length));
curDocStr.Trim();
mParamInfo[new String(paramName)] = curDocStr;
lineHadContent = true;
}
}
else if (pragmaName == "brief")
{
if (mBriefString == null)
mBriefString = new String(pragma.Length);
else if (mBriefString != null)
{
if (!mBriefString[mBriefString.Length - 1].IsWhiteSpace)
mBriefString.Append(" ");
}
var briefStr = StringView(pragma, splitEnum.MatchPos + 1);
briefStr.Trim();
mBriefString.Append(briefStr);
curDocStr = mBriefString;
lineHadContent = true;
AddPragma(ref mBriefString, pragma, splitEnum);
}
else if (pragmaName == "author")
{
AddPragma(ref mAuthorString, pragma, splitEnum);
}
else if (pragmaName == "return" || pragmaName == "retVal")
{
AddPragma(ref mReturnString, pragma, splitEnum);
}
else if (pragmaName == "remarks")
{
AddPragma(ref mRemarksString, pragma, splitEnum);
}
else if (pragmaName == "note")
{
AddPragma(ref mNoteString, pragma, splitEnum);
}
else if (pragmaName == "todo" || pragmaName == "TODO")
{
AddPragma(ref mTODOString, pragma, splitEnum);
}
else if (pragmaName == "see")
{
AddPragma(ref mSeeAlsoString, pragma, splitEnum);
}
else if (pragmaName == "version")
{
AddPragma(ref mVersionString, pragma, splitEnum);
}
}
@ -1218,7 +1262,7 @@ namespace IDE.ui
if (docParser.mParamInfo != null)
{
if (docParser.mParamInfo.TryGetValue(scope String(paramName), var paramDoc))
if (docParser.mParamInfo.TryGetValue(scope String(paramName), var paramDoc) || paramName.IsEmpty)
{
curY += font.GetLineSpacing() + GS!(4);
if (g != null)