/*
* Copyright 2011 Jon S Akhtar (Sylvanaar)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.sylvanaar.idea.Lua.lang.documentor;
import com.intellij.lang.documentation.DocumentationProvider;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiManager;
import com.sylvanaar.idea.Lua.lang.psi.statements.LuaStatementElement;
import java.util.List;
/**
* Created by IntelliJ IDEA.
* User: Jon S Akhtar
* Date: 1/29/11
* Time: 8:26 AM
*/
public class ContextualDocumentationProvider implements DocumentationProvider {
@Override
public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) {
// only time we see the two eleements equal is when we call for documentation
// during parameter info display
if (element == originalElement) return null;
PsiElement s = element;
while (!(s instanceof LuaStatementElement) && s != null) {
s = s.getContext();
}
String s2 = s != null ? s.getText() : null;
if (s2 == null) return null;
String label = "[" + element.getContainingFile().getName() + "] \r\n";
return label + s2.split("[\n\r]")[0];
}
@Override
public List<String> getUrlFor(PsiElement element, PsiElement originalElement) {
return null; //To change body of implemented methods use File | Settings | File Templates.
}
@Override
public String generateDoc(PsiElement element, PsiElement originalElement) {
return null; //To change body of implemented methods use File | Settings | File Templates.
}
@Override
public PsiElement getDocumentationElementForLookupItem(PsiManager psiManager, Object object, PsiElement element) {
return null; //To change body of implemented methods use File | Settings | File Templates.
}
@Override
public PsiElement getDocumentationElementForLink(PsiManager psiManager, String link, PsiElement context) {
return null; //To change body of implemented methods use File | Settings | File Templates.
}
}